Skip to content

Commit

Permalink
doc: metadata TSV formatting for multiple barcodes
Browse files Browse the repository at this point in the history
  • Loading branch information
TimD1 committed Jul 17, 2024
1 parent 6ed98a3 commit 75bdee0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,14 @@ and placed in the given SAM record tag (`RX` by default). Similarly, the sample
barcode bases from the given read will be placed in the `BC` tag.

Metadata about the samples should be given as a headered metadata TSV file with
two columns 1. `sample_id` - the id of the sample or library. 2. `barcode` - the
expected barcode sequence associated with the `sample_id`.
at least the following two columns present:

1. `sample_id` - the id of the sample or library.
2. `barcode` - the expected barcode sequence associated with the `sample_id`.

For reads containing multiple barcodes (such as dual-indexed reads), all barcodes
should be concatenated together in the order they are read and stored in the
`barcode` field.

The read structures will be used to extract the observed sample barcode, template
bases, and molecular identifiers from each read. The observed sample barcode
Expand Down
9 changes: 7 additions & 2 deletions src/bin/commands/demux.rs
Original file line number Diff line number Diff line change
Expand Up @@ -518,9 +518,14 @@ impl DemuxMetric {
/// default). Similarly, the sample barcode bases from the given read will be placed in the `BC`
/// tag.
///
/// Metadata about the samples should be given as a headered metadata TSV file with two columns
/// 1. `sample_id` - the id of the sample or library.
/// Metadata about the samples should be given as a headered metadata TSV file with at least the
/// following two columns present:
///
/// 1. `sample_id` - the id of the sample or library.
/// 2. `barcode` - the expected barcode sequence associated with the `sample_id`.
///
/// For reads containing multiple barcodes (such as dual-indexed reads), all barcodes should be
/// concatenated together in the order they are read and stored in the `barcode` field.
///
/// The read structures will be used to extract the observed sample barcode, template bases, and
/// molecular identifiers from each read. The observed sample barcode will be matched to the
Expand Down

0 comments on commit 75bdee0

Please sign in to comment.