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

adapt pipeline to nf-schema 2.1.0 #87

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

nvnieuwk
Copy link

This PR shows an implementation of nf-schema 2.1.0 on the test pipeline. (Tests will fail because 2.1.0 has not been released yet).

Running nextflow run main.nf --help shows this:

$ nextflow run main.nf --help
Nextflow 24.04.4 is available - Please consider updating your version to it

 N E X T F L O W   ~  version 24.04.3

Launching `main.nf` [hopeful_meninsky] DSL2 - revision: d17b498066



------------------------------------------------------
                                        ,--./,-.
        ___     __   __   __   ___     /,-._.--~'
  |\ | |__  __ /  ` /  \ |__) |__         }  {
  | \| |       \__, \__/ |  \ |___     \`-._,-`-,
                                        `._,._,'
  nf-core/testpipeline 1.0dev
------------------------------------------------------
Typical pipeline command:

  nextflow run nf-core/testpipeline -profile <docker/singularity/.../institute> --input samplesheet.csv --outdir <OUTDIR>

--help                          [boolean, string] Show the help message for all top level parameters. When a parameter is given to `--help`, the full help message of that parameter will be printed. 
--helpFull                      [boolean]         Show the help message for all non-hidden parameters. 
--showHidden                    [boolean]         Show all hidden parameters in the help message. This needs to be used in combination with `--help` or `--helpFull`. 

Input/output options
  --input                       [string] Path to comma-separated file containing information about the samples in the experiment. 
  --outdir                      [string] The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure. 
  --email                       [string] Email address for completion summary. 
  --multiqc_title               [string] MultiQC report title. Printed as page header, used for filename if not otherwise specified. 

Reference genome options
  --genome                      [string] Name of iGenomes reference. 
  --fasta                       [string] Path to FASTA genome file. 

Generic options
  --multiqc_methods_description [string] Custom MultiQC yaml file containing HTML including a methods description. 

 !! Hiding 24 param(s), use the `--showHidden` parameter to show them !!
------------------------------------------------------
If you use nf-core/testpipeline for your analysis please cite:

* The pipeline
  

* The nf-core framework
  https://doi.org/10.1038/s41587-020-0439-x

* Software dependencies
  https://github.com/nf-core/testpipeline/blob/master/CITATIONS.md

This comment was marked as off-topic.

@nvnieuwk
Copy link
Author

}
}

def workflowCitations() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will we be able to define these function in a NF script instead of the config? Since code is not advised in config files and it might be disabled in the future.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure yet, we would need to get creative here I think. I've not really given it much thought yet but I'm sure we can come up with a sensible solution. The main problem is that we need to dynamically create these files which would always need a function. AFAIK we can't access script functions in the configs?

@nvnieuwk nvnieuwk changed the base branch from master to schema-test-nf-schema August 21, 2024 11:13
@nvnieuwk nvnieuwk changed the base branch from schema-test-nf-schema to master August 21, 2024 13:28
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.

2 participants