Skip to content

Commit

Permalink
remove example, clean README
Browse files Browse the repository at this point in the history
  • Loading branch information
caleb-easterly committed Mar 13, 2019
1 parent 17d84c2 commit 495d629
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 54 deletions.
51 changes: 5 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@

Quantitative analysis of the function and taxonomy of microbiomes and their interaction.

# Setup

# Developers

## Setup

The newest version of metaquantome should be downloaded from this site.
The dependencies are most easily satisfied with conda, and the environment can
Expand All @@ -21,53 +24,9 @@ source activate metaquantome
Note that the bioconda and conda forge channels must be enabled,
as described on [the bioconda website](https://bioconda.github.io/#set-up-channels).

# Tests
## Tests
To run unittests for the project, run the following from the root directory:

```sh
python -m unittest discover tests
```

# Basic usage

We can use example files within the `examples` directory to demonstrate the use of the command line.

```sh
python3 cli.py expand -m f \
--pep_colname peptide --outfile test.tmp -i example/int.tab \
--func_file example/func.tab --func_colname go --ontology go \
--samps '{"s1": ["int1", "int2", "int3"], "s2": ["int4", "int5", "int6"]}'
```

# Roadmap

## High Priority
- visualizations
- documentation
- better arg checking
- deal with sample that is completely missing values
- deal with missing values better
- taxonomy rank checking
- move ncbi checking to IO
- check that supplied columns are in the dataframe
- check that sample info provides a list, or is coerced to a list
- don't return above phylum
- don't return BP, MF, or CC
- raise error when all rows are filtered out
- strip any newlines in samps file
- configure Travis CI on Github


## Lower Priority
- benchmarking and optimization
- use flake8 for codestyle

## Done
- unified database structure and 'adding up'
- unify this with classes
- work on EC in particular
- how do we implement for COG cats?
- add handling if description is not found in database (EC)
- switch to metagenomics slim
- add option for specific rank in TF
- move threshold to calculating mean values as well
4 changes: 0 additions & 4 deletions example/func.tab

This file was deleted.

4 changes: 0 additions & 4 deletions example/int.tab

This file was deleted.

0 comments on commit 495d629

Please sign in to comment.