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

Add --help flag for displaying usage information to users. #51

Merged
merged 2 commits into from
Aug 14, 2024

Conversation

ZaahidShaik
Copy link
Contributor

Changes:

  • This PR, adds change for introducing new --help option for users to get the usage information for AIM next-flow pipeline.

TESTING :

  • In the AI_MARRVEL dir, run the command given below.
nextflow run main.nf --help
  • expected output :
 N E X T F L O W   ~  version 24.04.2

Launching `main.nf` [loquacious_bohr] DSL2 - revision: 5b9ee9fd9c

Usage: 
      
    nextflow run main.nf [All Args] [Options]
        
Example:  

    nextflow run main.nf --ref_dir   path/to/aim_data_dependencies \
                         --input_vcf path/to/sample.vcf.gz \
                         --input_hpo path/to/sample/hpos.txt \
                         --outdir    path/to/sample/Output \ 
                         --run_id [Sample ID] \
                         --ref_ver [hg19/hg38] 

Args:
  --input_vcf               Path to input VCF file.
  --input_hpo               Path to input HPO file.
  --ref_dir                 Path to aim pipeline dependencies directory.
  --outdir                  Output directory.
  --run_id                  Unique identifier for this run. (default: 1)
  --ref_ver                 Reference genome version [hg38 or hg19] (default: hg19)
                  

Options:
  --exome_filter            Enable exonic filter. Addition will filter out variants outside of exonic region  (default: false)
  --help                    Displays the usage information.

Reference Files:
  --ref_loc                 Path to reference location file
  --ref_to_sym              Path to reference to symbol file
  --ref_sorted_sym          Path to reference sorted symbol file
  --ref_exonic_filter_bed   Path to exonic filter BED file

VEP Annotation:
  --vep_dir_cache           Path to VEP cache directory
  --vep_dir_plugins         Path to VEP plugins directory
  --vep_custom_gnomad       Path to custom gnomAD file for VEP
  --vep_custom_clinvar      Path to custom ClinVar file for VEP
  --vep_custom_hgmd         Path to custom HGMD file for VEP

For detailed information about each process, 
please refer to the documentation. https://ai-marrvel.readthedocs.io/en/latest/ 

QA :

  • Happy Case: Tested cmd nextflow run main.nf --help got the expected output.
  • Fail Case : Tested cmd nextflow run main.nf , got error and workflow was terminated with output given below as expected.
 N E X T F L O W   ~  version 24.04.2

Launching `main.nf` [curious_mercator] DSL2 - revision: 5b9ee9fd9c

WARN: Access to undefined parameter `input_vcf` -- Initialise it to a default value eg. `params.input_vcf = some_value`
ERROR ~ A process input channel evaluates to null -- Invalid declaration `path vcf`

 -- Check script 'main.nf' at line: 387 or see '.nextflow.log' file for more details
 

Copy link
Contributor

@hyunhwan-bcm hyunhwan-bcm left a comment

Choose a reason for hiding this comment

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

LGTM, do the one single change then we can merge it. Thanks for doing this quickly!

docs/source/nf_usage.txt Show resolved Hide resolved
nextflow.config Show resolved Hide resolved
@hyunhwan-bcm hyunhwan-bcm merged commit 07c75e0 into LiuzLab:nextflow_conversion Aug 14, 2024
1 check failed
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