Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for v0.0.101 #5

Merged
merged 1 commit into from
Feb 27, 2022
Merged

Update docs for v0.0.101 #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@ nav_order: 99

# Version changelog

**0.0.101**
* Update to CLI

**0.0.100**
* Alpha release of `skera`
13 changes: 11 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,18 @@ page](https://github.com/PacificBiosciences/pbbioconda) for information on
Installation, Support, License, Copyright, and Disclaimer.

## Versions
Version **0.0.100**: [Full changelog here](/changelog)
Version **0.0.101**: [Full changelog here](/changelog)

## Input
### Reads
HiFi reads in PacBio BAM format.

### Adapters
Adapters must be in FASTA format `<adapters.fasta>` and ordered in the expected
order of adapters in the reads. There should be one entry per adapter (forward
or reverse-complement orientation) with no overlapping adapter sequences.

## Execution
Skera run on HiFi reads in PacBio BAM format:

skera --algorithm kmer <movie>.hifi_reads.bam adapters.fasta <movie>.skera.bam
skera <movie>.hifi_reads.bam adapters.fasta <movie>.skera.bam