Skip to content

Commit

Permalink
Test formatting for sunbeam init
Browse files Browse the repository at this point in the history
  • Loading branch information
Ulthran committed Oct 12, 2022
1 parent e7ef387 commit 48f4d9e
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions docs/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,31 @@ Sunbeam Commands
init
====

sunbeam init [-h] [-f] [--output FILE] [--defaults FILE] [--template FILE]
[--data_fp PATH] [--format STR] [--single_end] project_fp

-h/--help: Display help.
.. code-block:: shell
-f/--force: Overwrite files if they already exist.
sunbeam init [-h] [-f] [--output FILE] [--defaults FILE] [--template FILE] [--data_fp PATH] [--format STR] [--single_end] project_fp
--output: Name of config file (default: sunbeam_config.yml).
.. code-block:: shell
--defaults: Set of default values to use to populate config file.
-h/--help: Display help.
-f/--force: Overwrite files if they already exist.
--output: Name of config file (default: sunbeam_config.yml).
--template: Custom config file template, in YAML format.
Config file options:
--data_fp: Path to folder containing `.fastq.gz` files.
.. code-block:: shell
--format: Filename format for --data_fp (default: guessed).
--defaults: Set of default values to use to populate config file.
--template: Custom config file template, in YAML format.
--single_end: Fastq files are in single-end, not paired-end, format for --data_fp.
Sample list options:
project_fp: Project directory (will be created if it does not exist).
.. code-block:: shell
--data_fp: Path to folder containing `.fastq.gz` files.
--format: Filename format for --data_fp (default: guessed).
--single_end: Fastq files are in single-end, not paired-end, format for --data_fp.
project_fp: Project directory (will be created if it does not exist).
run
===
Expand Down

0 comments on commit 48f4d9e

Please sign in to comment.