Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
pirovc committed Mar 7, 2022
1 parent 9051dcb commit 4605afb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 31 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![GRIMER](grimer/img/logo.png)

GRIMER automates analysis and reports an offline and interactive dashboard integrating annotation, taxonomy and metadata to analyse microbiome studies and detect contamination.
GRIMER perform analysis of microbiome data and generates a portable and interactive dashboard integrating annotation, taxonomy and metadata.

## Examples

Expand All @@ -22,19 +22,34 @@ grimer -h

## Usage

### Basic
### Tab-separated input table
```bash
grimer -i input_table.tsv -m metadata.tsv -c config/default.yaml
grimer -i input_table.tsv
```

### BIOM file
```bash
grimer -i myfile.biom
```

### Tab-separated input table with taxonomic annotated observations (e.g. sk__Bacteria;k__;p__Actinobacteria;c__Actinobacteria...)
```bash
grimer -i input_table.tsv -f ";"
```

### Tab-separated input table with metadata
```bash
grimer -i input_table.tsv -m metadata.tsv
```

### With taxonomy integration (ncbi)
```bash
grimer -i input_table.tsv -m metadata.tsv -c config/default.yaml -t ncbi #optional -b taxdump.tar.gz
grimer -i input_table.tsv -m metadata.tsv -t ncbi #optional -b taxdump.tar.gz
```

### With DECONTAM and MGnify annotations
### With configuration file to setup external tools, references and annotations
```bash
grimer -i input_table.tsv -m metadata.tsv -c config/default.yaml -d -g
grimer -i input_table.tsv -m metadata.tsv -t ncbi -c config/default.yaml -d -g
```

### List all options
Expand Down
25 changes: 0 additions & 25 deletions grimer/mgnify.py

This file was deleted.

0 comments on commit 4605afb

Please sign in to comment.