Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation does not fit pipeline behaviour. #156

Closed
oliverdrechsel opened this issue Sep 5, 2023 · 3 comments · Fixed by #175
Closed

Documentation does not fit pipeline behaviour. #156

oliverdrechsel opened this issue Sep 5, 2023 · 3 comments · Fixed by #175
Assignees
Labels
bug Something isn't working
Milestone

Comments

@oliverdrechsel
Copy link

Description of the bug

https://nf-co.re/differentialabundance/1.2.0/docs/usage mentions in section Contrasts file
blocking is listed under optional arguments.

Leaving out this column from contrasts file, the pipeline will complain

  Error in read_contrasts(contrasts_file, samples) :
    Contrasts file must contain all of variable, reference, target, blocking
  Calls: validate_inputs -> read_contrasts
  Execution halted

In addtion documentation's Quick start mentions
-profile rnaseq

using this profile will cause an error message that this profile is not defined

Unknown configuration profile: 'rnaseq'

Command used and terminal output

# this call fuses both issues

$ nextflow run nf-core/differentialabundance      \
--input samplesheet.csv      \
--contrasts contrasts_small.noblocking.csv      \
--matrix salmon.merged.gene_counts.tsv      \
--gtf references/Homo_sapiens.GRCh37.87.gtf      \
--outdir test_output      \
-profile rnaseq,rki_slurm,rki_singularity,singularity

Relevant files

# contrasts file

id,variable,reference,target,exclude_samples_col,exclude_samples_values
infected_time_comparison,incubation,15,24,condition,control

System information

N E X T F L O W ~ version 23.04.1
https://github.com/nf-core/differentialabundance [determined_waddington] DSL2 - revision: 3a849f0 [master]

@oliverdrechsel oliverdrechsel added the bug Something isn't working label Sep 5, 2023
@WackerO WackerO self-assigned this Oct 5, 2023
@WackerO
Copy link
Collaborator

WackerO commented Oct 5, 2023

Hey there @oliverdrechsel

So regarding the unknown profile I am very sorry, but I cannot reproduce that error...I just ran the pipeline with that profile and it worked just fine; it is defined in the nextflow.config.

Regarding the problem with the contrasts file, your layout is not correct. I can see how the docu is a bit unclear in that regard, I will update it.
I'm not quite sure what the contrasts should look like in your case but I believe it might be this?

id,variable,reference,target,blocking,exclude_samples_col,exclude_samples_values
infected_time_comparison,incubation,15,24,,condition,control

That is to say, the header of the csv file has to be the same always; the entry for blocking can be left out, but the word blocking itself still has to appear in the header row. I'll specify this in the docs :)

I'm closing this for now, don't hesitate to reopen if you still have trouble with the pipeline!

@WackerO WackerO closed this as completed Oct 5, 2023
@WackerO WackerO reopened this Oct 5, 2023
@WackerO
Copy link
Collaborator

WackerO commented Oct 5, 2023

Just had a look at the code, my bad; the optional columns are treated a bit differently right now, i.e. exclude_samples_col and exclude_samples_values are truly optional whereas for blocking, at least the column name seems to be necessary right now. Will see if I can change this during the hackathon 💪

@pinin4fjords pinin4fjords added this to the 1.3.0 milestone Oct 10, 2023
@pinin4fjords pinin4fjords linked a pull request Oct 18, 2023 that will close this issue
9 tasks
@pinin4fjords
Copy link
Member

#175, combined with pinin4fjords/shinyngs#57, addresses this issue.

@pinin4fjords pinin4fjords mentioned this issue Oct 19, 2023
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants