Skip to content

Commit

Permalink
docs(config/README.md): include update parameters
Browse files Browse the repository at this point in the history
The move to CellRanger changed the input parameters. This is now reflected in the documentation for the configuration files.
  • Loading branch information
rbpatt2019 committed Jan 10, 2022
1 parent a276364 commit 4e39a2d
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ This defaults to `config/samples.yaml`.
Path to the "lift sheet" - the PolyA-DB outputs.
This defaults to `config/lift.yaml`.

### get_whitelist
### get_cellranger

- url: str, required. Url to retrieve cell barcode whitelist for STAR.
- url: str, required. Url to retrive the CellRanger binary.

### get_gtf

Expand All @@ -54,4 +54,10 @@ This defaults to `config/lift.yaml`.

- url: str, required. Url to retrieve the `mm10` to `mm39` over.chain for `LiftOver`

### cellranger

- introns: bool, required. Whether or not to include introns in the allignment. Essentially specifies if the data is single-nucleus or single cell.
- n_cells: int, required. The number of cells to expect in the sample.
- mem: int, required. The local memory, in Gb, available to CellRanger.

[schema]: https://snakemake.readthedocs.io/en/stable/snakefiles/configuration.html#validation "Schema Validation"

0 comments on commit 4e39a2d

Please sign in to comment.