papaemmelab / toil_container

:whale: Toil + Docker and Singularity.
MIT License
9 stars 6 forks source link

πŸš€ add help container feature #18

Closed jsmedmar closed 6 years ago

jsmedmar commented 6 years ago

Hide container options by default and add --help-container to display them.

See example:

usage: toil_disambiguate [-h] [-v] [--help-toil] [--help-container]
                         --input_data INPUT_DATA [INPUT_DATA ...]
                         --sample_name SAMPLE_NAME --reference_a REFERENCE_A
                         --reference_b REFERENCE_B
                         [--max_cores_usage MAX_CORES_USAGE]
                         [--max_memory_usage MAX_MEMORY_USAGE]
                         [--keep_intermediates]
                         jobStore

toil_disambiguate pipeline

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  --help-toil           show help with toil arguments and exit
  --help-container      show help with container arguments and exit

pipeline arguments:
  --outdir OUTDIR       path to output directory (default: None)
  ...

toil arguments:
  jobStore              the location of the job store for the workflow. See
                        --help-toil for more toil options and information
                        [REQUIRED]
codecov[bot] commented 6 years ago

Codecov Report

Merging #18 into master will increase coverage by 0.82%. The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff            @@
##           master    #18      +/-   ##
========================================
+ Coverage   99.17%   100%   +0.82%     
========================================
  Files           5      5              
  Lines         243    256      +13     
========================================
+ Hits          241    256      +15     
+ Misses          2      0       -2
Impacted Files Coverage Ξ”
toil_container/containers.py 100% <100%> (+1.94%) :arrow_up:
toil_container/parsers.py 100% <100%> (ΓΈ) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Ξ” = absolute <relative> (impact), ΓΈ = not affected, ? = missing data Powered by Codecov. Last update 7e32ff1...6335afe. Read the comment docs.

jsmedmar commented 6 years ago

@juanesarango, this is ready for review + merge :shipit: