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

fix: Nextflow profile #456

Merged
merged 14 commits into from Mar 17, 2022
Merged

fix: Nextflow profile #456

merged 14 commits into from Mar 17, 2022

Conversation

tpall
Copy link
Contributor

@tpall tpall commented Feb 14, 2022

Description

  • Fixed bug where Nextflow -profile option was inserted also second time with double hyphens (--profile ..) to nextflow call.
  • Added snakemake extra parameter to pass other single hyphen options to nextflow (e.g. -resume []).
  • Removed nextflow version from environment file.

All these have been tested by running nf-core/mag pipeline.

QC

For all wrappers added by this PR, I made sure that

  • there is a test case which covers any introduced changes,
  • input: and output: file paths in the resulting rule can be changed arbitrarily,
  • either the wrapper can only use a single core, or the example rule contains a threads: x statement with x being a reasonable default,
  • rule names in the test case are in snake_case and somehow tell what the rule is about or match the tools purpose or name (e.g., map_reads for a step that maps reads),
  • all environment.yaml specifications follow the respective best practices,
  • wherever possible, command line arguments are inferred and set automatically (e.g. based on file extensions in input: or output:),
  • all fields of the example rules in the Snakefiles and their entries are explained via comments (input:/output:/params: etc.),
  • stderr and/or stdout are logged correctly (log:), depending on the wrapped tool,
  • temporary files are either written to a unique hidden folder in the working directory, or (better) stored where the Python function tempfile.gettempdir() points to (see here; this also means that using any Python tempfile default behavior works),
  • the meta.yaml contains a link to the documentation of the respective tool or command,
  • Snakefiles pass the linting (snakemake --lint),
  • Snakefiles are formatted with snakefmt,
  • Python wrapper scripts are formatted with black.

tpall and others added 6 commits December 6, 2021 23:38
Fix
ERROR: You used a core Nextflow option with two hyphens: '--profile'. Please resubmit with '-profi
le'

WARN: Found unexpected parameters:
* --profile: [singularity]

nextflow run nf-core/mag -revision 2.1.1 -profile singularity --input output/SRR13435231.csv --profile ['singularity']
Added extra parameter to accommodate additional workflow flags.
@tpall tpall changed the title Nf profile Fix: Nextflow profile Feb 14, 2022
@tpall tpall changed the title Fix: Nextflow profile fix: Nextflow profile Feb 14, 2022
@johanneskoester
Copy link
Contributor

Can you please reformat your changes with black?

@fgvieira
Copy link
Collaborator

fgvieira commented Mar 9, 2022

Are you using the latest black version? According to #460, GitHub Runners use version 22.1.0.

@johanneskoester
Copy link
Contributor

You also need to format other wrappers (maybe just bad luck, sorry):

black bio/gatk/applybqsrspark/wrapper.py bio/biobambam2/bamsormadup/wrapper.py

@fgvieira
Copy link
Collaborator

Those formatting issues have already been fixed in master, so just rebase your branch to the current master.

@johanneskoester
Copy link
Contributor

ping @tpall

tpall and others added 7 commits March 16, 2022 16:52
Fix
ERROR: You used a core Nextflow option with two hyphens: '--profile'. Please resubmit with '-profi
le'

WARN: Found unexpected parameters:
* --profile: [singularity]

nextflow run nf-core/mag -revision 2.1.1 -profile singularity --input output/SRR13435231.csv --profile ['singularity']
Added extra parameter to accommodate additional workflow flags.
@tpall
Copy link
Contributor Author

tpall commented Mar 16, 2022

I was using black version 21.6b0, but version 22.1.0 was happy too.

@johanneskoester
Copy link
Contributor

Thanks!

@johanneskoester johanneskoester merged commit bd9af55 into snakemake:master Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants