Skip to content

Commit

Permalink
misc documentation corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
donaldcampbelljr committed Nov 8, 2023
1 parent 107a924 commit 402cd2d
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ unzip master.zip

# Run looper:
cd hello_looper-master
looper run project/project_config.yaml
looper run --looper-config .looper.yaml project/project_config.yaml
```

Detailed explanation of results is in the [Hello world tutorial](hello-world.md).
2 changes: 1 addition & 1 deletion docs/pipestat.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Starting with version 1.4.0, looper supports additional functionality for [pipes
1. monitor the status of pipeline runs
2. summarize the results of pipelines

For non-pipestat-compatible pipelines, you can still use looper to run pipelines, but you won't be able to use `looper report` or `looper status` to manage their output.
For non-pipestat-compatible pipelines, you can still use looper to run pipelines, but you won't be able to use `looper report` or `looper check` to manage their output.

## Pipestat configuration overview
Starting with version 1.6.0 configuring looper to work with pipestat has changed.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Each task is controlled by one of the following commands: `run`, `rerun`, `runp`

- `looper destroy`: Deletes all output results for this project.

- `looper inspect`: Display the Prioject or Sample information
- `looper inspect`: Display the Project or Sample information

- `looper init`: Initialize a looper dotfile (`.looper.yaml`) in the current directory

Expand Down
8 changes: 3 additions & 5 deletions docs/variable-namespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,9 @@ So, the compute namespace is first populated with any variables from the selecte

The `pipestat` namespace conists of a group of variables that reflect the [pipestat](http://pipestat.databio.org) configuration for a submission.

1. schema (`PipestatManager.schema_path`)
2. results_file (`PipestatManager.file`)
3. record_id (`PipestatManager.record_identifier`)
4. namespace (`PipestatManager.namespace`)
5. config (`PipestatManager.config_path`)
1. results_file (`PipestatManager.file`)
2. record_id (`PipestatManager.record_identifier`)
3. config (`PipestatManager.config_path`)

## Mapping variables to submission templates using divvy adapters

Expand Down

0 comments on commit 402cd2d

Please sign in to comment.