Skip to content

Commit

Permalink
added CLI reference for normalization
Browse files Browse the repository at this point in the history
  • Loading branch information
qiyunzhu committed Jul 6, 2021
1 parent 9a21a2c commit eff5a8d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions doc/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Option | Description

Filter a profile by **per-sample** abundance.

* See [Per-sample filtering](filter.md) for details.

Option | Description
--- | ---
`--input`, `-i` (required) | Path to input alignment file or directory of alignment files.
Expand All @@ -110,11 +112,27 @@ Option | Description

Merge multiple profiles into one profile.

* See [Merging profiles](merge.md) for details.

Option | Description
--- | ---
`--input`, `-i` (required) | Path to input profiles or directories containing profiles. Can accept multiple paths.
`--output`, `-o` (required) | Path to output profile.

### Normalize

Normalize a profile to fractions or by feature sizes.

* See [Profile normalization](normalize.md) for details.

Option | Description
--- | ---
`--input`, `-i` (required) | Path to input profile.
`--output`, `-o` (required) | Path to output profile.
`--sizes`, `-z` | Path to mapping of feature sizes, by which values will be divided. If omitted, will divide values by sum per sample.
`--scale`, `-s` | Scale values by this factor. Accepts "k", "M" suffixes.
`--digits`, `-d` | Round values to this number of digits after the decimal point. If omitted, will keep decimal precision of input profile.

### Collapse

Collapse a profile based on feature mapping (supports **many-to-many** mapping) (details).
Expand Down
2 changes: 1 addition & 1 deletion doc/normalize.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Data normalization
# Profile normalization

By default, the cell values in a feature table (profile) are **counts** (**frequencies**) of each feature in each sample. This behavior maximizes the flexibility of downstream analyses. Meanwhile, Woltka provides multiple functions for normalizing cell values to alternative units and scales:

Expand Down

0 comments on commit eff5a8d

Please sign in to comment.