Skip to content

Commit 8d15d81

Browse files
add notes about nested hierarchy, cli key in looper config file
1 parent 47d96fe commit 8d15d81

File tree

2 files changed

+12
-24
lines changed

2 files changed

+12
-24
lines changed

Diff for: docs/looper/defining-a-project.md

-24
Original file line numberDiff line numberDiff line change
@@ -73,27 +73,3 @@ sample_modifiers:
7373
extend: "250" # Default. For fixed-width peaks, extend this distance up- and down-stream.
7474
frip_ref_peaks: None # Default. Use an external reference set of peaks instead of the peaks called from this run
7575
```
76-
77-
78-
## 3. Customize looper
79-
80-
You can also customize things further. Under the `looper` section, you can provide a `cli` keyword to specify any command line (CLI) options from within the project config file. The subsections within this section direct the arguments to the respective `looper` subcommands. So, to specify, e.g. sample submission limit for a `looper run` command use:
81-
82-
```yaml
83-
looper:
84-
output_dir: "/path/to/output_dir"
85-
cli:
86-
run:
87-
limit: 2
88-
```
89-
90-
or, to pass this argument to any subcommand:
91-
92-
```yaml
93-
looper:
94-
output_dir: "/path/to/output_dir"
95-
all:
96-
limit: 2
97-
```
98-
99-
Keys in the `cli.<subcommand>` section *must* match the long argument parser option strings, so `command-extra`, `limit`, `dry-run` and so on. For more CLI options refer to the subcommands [usage](usage.md).

Diff for: docs/looper/looper-config.md

+12
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,15 @@ one of supported ways: `namespace/name`, `namespace/name:tag`)
3434

3535
To run pipeline, go to the directory of .looper.config and execute command in your terminal:
3636
`looper run --looper-config {looper_config_path}` or `looper runp --looper-config {looper_config_path}` (project-level pipeline).
37+
38+
## Customize looper
39+
40+
You can also customize things further. You can provide a `cli` keyword to specify any command line (CLI) options from within the looper config file. The subsections within this section direct the arguments to the respective `looper` subcommands. So, to specify, e.g. sample submission limit for a `looper run` command use:
41+
42+
```yaml
43+
cli:
44+
run:
45+
limit: 2
46+
```
47+
48+
Keys in the `cli.<subcommand>` section *must* match the long argument parser option strings, so `command-extra`, `limit`, `dry-run` and so on. For more CLI options refer to the subcommands [usage](usage.md).

0 commit comments

Comments
 (0)