Skip to content

Commit

Permalink
add notes about nested hierarchy, cli key in looper config file
Browse files Browse the repository at this point in the history
  • Loading branch information
donaldcampbelljr committed Jun 26, 2024
1 parent 47d96fe commit 8d15d81
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 24 deletions.
24 changes: 0 additions & 24 deletions docs/looper/defining-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,27 +73,3 @@ sample_modifiers:
extend: "250" # Default. For fixed-width peaks, extend this distance up- and down-stream.
frip_ref_peaks: None # Default. Use an external reference set of peaks instead of the peaks called from this run
```


## 3. Customize looper

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:

```yaml
looper:
output_dir: "/path/to/output_dir"
cli:
run:
limit: 2
```

or, to pass this argument to any subcommand:

```yaml
looper:
output_dir: "/path/to/output_dir"
all:
limit: 2
```

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).
12 changes: 12 additions & 0 deletions docs/looper/looper-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,15 @@ one of supported ways: `namespace/name`, `namespace/name:tag`)

To run pipeline, go to the directory of .looper.config and execute command in your terminal:
`looper run --looper-config {looper_config_path}` or `looper runp --looper-config {looper_config_path}` (project-level pipeline).

## Customize looper

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:

```yaml
cli:
run:
limit: 2
```

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 comments on commit 8d15d81

Please sign in to comment.