Skip to content

Commit

Permalink
Draft input description. (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
mstrazar authored and mortonjt committed Jan 7, 2020
1 parent fed180c commit a520b32
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ conda install mmvec -c conda-forge

Note that this option may not work in cluster environments, it maybe workwhile to pip install within a virtual environment. It is possible to pip install mmvec within a conda environment, including qiime2 conda environments. However, pip and conda are known to have compatibility issues, so proceed with caution.

# Input data

The two basic tables required to run mmvec are:

- Metabolite counts (.biom): A table with metabolites in rows and samples in columns.
- Microbe abundance (.biom): A relative abundance table with microbial species in rows and samples in columns.

# Getting started

To get started you can run a quick example as follows. This will learn microbe-metabolite vectors (mmvec)
Expand Down

0 comments on commit a520b32

Please sign in to comment.