Skip to content

Commit

Permalink
adapt readme
Browse files Browse the repository at this point in the history
  • Loading branch information
a-h-b authored Aug 9, 2022
1 parent 8279599 commit 9cb1abe
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ sed -i -e "s|prokka_env: \"\"|prokka_env: \"${my_prokka_env}\"|g" \
```
./binny -i config/config.init.yaml
```
Binny uses the database of CheckM marker genes, which is downloaded and prepared at this point. See the [CheckM](#checkm-databases) section below, if you want to retrieve it manually.

4) Test run
```
Expand Down Expand Up @@ -119,4 +120,13 @@ The marker gene data file `checkm_data_2015_01_16.tar.gz` is downloaded from [he
* checkm.hmm

The processed marker gene file, `taxon_marker_sets_lineage_sorted.tsv`, can be found in the `database` directory by default and is generated using `remove_unused_checkm_hmm_profiles.py` found under
`workflow/scripts`.
`workflow/scripts`.

To set the files up manually, create the `database` directory and download `https://data.ace.uq.edu.au/public/CheckM_databases/checkm_data_2015_01_16.tar.gz` into it, before initializing binny, e.g.:
```
mkdir database
cd database
wget https://data.ace.uq.edu.au/public/CheckM_databases/checkm_data_2015_01_16.tar.gz
cd ..
./binny -i config/config.init.yaml
```

0 comments on commit 9cb1abe

Please sign in to comment.