Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mrvollger committed Aug 1, 2024
1 parent c6cbdf1 commit e277ac9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,28 +31,28 @@ However, due to size constraints in `bioconda` this version does not support con
ft --help
```

[Help page for fibertools](/docs/help.md)
[Help page for fibertools](https://fiberseq.github.io/fibertools/help.html#ft)

# Highlighted subcommands for `fibertools-rs`

### `ft predict-m6a`

Predict m6A positions using HiFi kinetics data and encode the results in the MM and ML bam tags. [Help page for predict-m6a](/docs/help.md#ft-predict-m6a).
Predict m6A positions using HiFi kinetics data and encode the results in the MM and ML bam tags. [Help page for predict-m6a](https://fiberseq.github.io/fibertools/help.html#ft-predict-m6a).

### `ft add-nucleosomes`

Add nucleosomes to a bam that file already contains m6a predictions. Note, this process is also run in the background during `predict-m6a`, so it is unnecessary to run independently unless you want to try new parameters for nucleosome calling. [Help page for add-nucleosomes](/docs/help.md#ft-add-nucleosomes).
Add nucleosomes to a bam that file already contains m6a predictions. Note, this process is also run in the background during `predict-m6a`, so it is unnecessary to run independently unless you want to try new parameters for nucleosome calling. [Help page for add-nucleosomes](https://fiberseq.github.io/fibertools/help.html#ft-add-nucleosomes).

### `ft extract`

Extracts Fiber-seq data from a bam file into plain text. [Docs for extract](/docs/extract.md).
Extracts Fiber-seq data from a bam file into plain text. [Docs for extract](https://fiberseq.github.io/fibertools/help.html#ft-extract).

### `ft center`

Center Fiber-seq reads (bam) around reference position(s). [Docs for center](/docs/center.md).
Center Fiber-seq reads (bam) around reference position(s). [Docs for center](https://fiberseq.github.io/fibertools/help.html#ft-center).

### `ft footprint`
Footprint Fiber-seq reads (bam) around reference motifs(s). [Docs for footprint](/docs/footprint.md).
Footprint Fiber-seq reads (bam) around reference motifs(s). [Docs for footprint](https://fiberseq.github.io/fibertools/help.html#ft-footprint).

# Python API (`pyft`)

Expand Down

0 comments on commit e277ac9

Please sign in to comment.