Skip to content

Commit

Permalink
Adds description of the taxonomy metadata.
Browse files Browse the repository at this point in the history
The README now contains a paragraph mentioning that kraken-biom stores the taxonomy for each OTU in the standard QIIME format, and that other formats may be supported in the future.
  • Loading branch information
smdabdoub committed Aug 31, 2016
1 parent dea7421 commit b7db885
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ Python library 'h5py'. If the library is not installed, kraken-biom will
automatically switch to using version 1.0. Note that the output can
optionally be compressed with gzip (--gzip) for version 1.0 and TSV files.
Version 2 files are automatically compressed.

Currently the taxonomy for each OTU ID is stored as row metadata in the BIOM
table using the standard seven-level QIIME format: k__K; p__P; ... s__S. If
you would like another format supported, please file an issue or send a pull
request (note the contribution guidelines).
::

usage: kraken-biom.py [-h] [--max {D,P,C,O,F,G,S}] [--min {D,P,C,O,F,G,S}]
Expand Down

0 comments on commit b7db885

Please sign in to comment.