You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In an effort to improve docs, we should add the -h flag to all the MIPTools apps. Then the user can type the flag and get a nicely formatted man page. An example format that we could use is below:
Description
Usage:
singularity run [options] --app [app_options]
Options:
See 'singularity run'.
App Options:
-a Required. Description
-b Optional argument. Default value.
-h Print the help page.
Examples:
# Set paths
$ resource_dir=/bin/MIPTools/base_resources
$ dir=/work/usr/example
# Run app
$ singularity run
-B $resource_dir:/opt/resources -B $dir:/opt/analysis
--app -h
The text was updated successfully, but these errors were encountered:
In an effort to improve docs, we should add the
-h
flag to all the MIPTools apps. Then the user can type the flag and get a nicely formatted man page. An example format that we could use is below:The text was updated successfully, but these errors were encountered: