Skip to content

Commit

Permalink
Merge pull request #17 from PacificBiosciences/update-min-score-docs
Browse files Browse the repository at this point in the history
Update min-score and hifi presets docs
  • Loading branch information
jmattick authored Dec 12, 2023
2 parents 63d8272 + 88bb8ff commit c8ab581
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/faq/filter-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ step. The default is `0`, meaning deactivated.

## `--min-score`
Threshold for the average barcode score of the leading and trailing ends.
ZMWs with barcode score below `N` are omitted. The default is `0`.
ZMWs with barcode score below or equal to `N` are omitted. The default is `0`.
It is advised to set it to `26` for CLR and `80` for HiFi.

## `--min-passes`
Expand Down
12 changes: 4 additions & 8 deletions docs/faq/hifi-presets.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,13 @@ title: HiFi Presets

## HiFi presets
With v2.5.0 we introduced the concept of recommended parameter presets called
`--hifi-preset`. All preset use

--ccs --min-score 80 --min-end-score 50 --min-ref-span 0.75

in addition they differ as following
`--hifi-preset`.

| Preset | Definition |
| -------------------- | ------------------------------------- |
| `SYMMETRIC` | `--same` |
| `SYMMETRIC-ADAPTERS` | `--same --ignore-missing-adapters` |
| `ASYMMETRIC` | `--different --min-scoring-regions 2` |
| `SYMMETRIC` | `--ccs --min-score 0 --min-end-score 80 --min-ref-span 0.75 --same --single-end` |
| `SYMMETRIC-ADAPTERS` | `--ccs --min-score 0 --min-end-score 80 --min-ref-span 0.75 --same --ignore-missing-adapters --single-end` |
| `ASYMMETRIC` | `--ccs --min-score 80 --min-end-score 50 --min-ref-span 0.75 --different --min-scoring-regions 2` |

For barcoded adapter libraries, `SYMMETRIC-ADAPTERS` will increase demultiplexed
yield. More info under [barcoded adapter FAQ](/faq/barcoded-adapter)

0 comments on commit c8ab581

Please sign in to comment.