Skip to content

Commit c02e5cb

Browse files
authored
Update README.md
Added info about download scripts
1 parent 56c2830 commit c02e5cb

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ CuCLARK is designed for workstations which can provide enough RAM to fit large d
88
CuCLARK-l uses a much smaller database and can be run on computers with 4 GB of RAM and
99
a CUDA-enabled with at least 1 GB of memory.
1010

11-
To use CuCLARK as a metagenome classier, it is recommended to use the provided scripts
11+
To use CuCLARK as a metagenome classifier, it is recommended to use the provided scripts
1212
for that purpose, which are detailed in the section "CLASSIFICATION OF METAGENOMIC SAMPLES".
1313

1414

@@ -117,6 +117,8 @@ In the main folder, you can also notice that several scripts are available.
117117
Especially:
118118
- `set_targets.sh` and `classify_metagenome.sh`: They allow you to classify your metagenomes
119119
against several database(s) (downloaded from NCBI or available "locally" in your disk).
120+
See section "CLASSIFICATION OF METAGENOMIC SAMPLES" for details.
121+
- `download_data.sh`, `download_taxondata.sh` and `make_metadata.sh` are called by `set_targets.sh` to download a specific database and taxonomy tree data from NCBI, and to associate the genomes of the database with the corresponding taxons, respectively. Although it is possible to use these scripts on their own, we recommend to simply use `set_targets.sh` to carry out all necessery steps.
120122

121123

122124

0 commit comments

Comments
 (0)