Skip to content

Commit 7774929

Browse files
authored
Update README.md
1 parent 46d8ee6 commit 7774929

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

+26-10
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,31 @@ If you use this reference set with the RDP classifier please also cite:
1414

1515
Wang et al. (2007) Naïve Bayesian classifier for rapid assignment of rRNA sequences into the new bacterial taxonomy. Applied and Environmental Microbiology, 73: 5261.
1616

17-
## How to use
18-
19-
Decompress the tar.gz file:
20-
21-
$ tar -xvzf FileName.tar.gz
22-
23-
Use with the RDP classifier:
24-
25-
java -Xmx8g -jar /path/to/rdp_classifier_2.12/dist/classifier.jar classify -t /path/to/mydata_trained/rRNAClassifier.properties -o ClassifiedQueryFilename QueryFilename
17+
## Quick Start
18+
```linux
19+
############ Install the RDP classifier if you need it
20+
# The easiest way to install the RDP classifier v2.13 is using conda
21+
conda install -c bioconda rdp_classifier
22+
# Alternatively, you can install from SourceForge and run with java if you don't use conda
23+
wget https://sourceforge.net/projects/rdp-classifier/files/rdp-classifier/rdp_classifier_2.13.zip
24+
# decompress it
25+
unzip rdp_classifier_2.13
26+
# record path to classifier.jar ex. /path/to/rdp_classifier_2.13/dist/classifier.jar
27+
28+
############ Get the latest 18S training set
29+
wget https://github.com/terrimporter/18SClassifier/releases/download/v4.1/18Sv4.1_mydata_trained.zip
30+
31+
# decompress it
32+
unzip 18Sv4.1_mydata_trained.zip
33+
34+
# record the path to the rRNAClassifier.properties file ex. /path/to/mydata_trained/rRNAClassifier.properties
35+
36+
############ Run the RDP Classifier
37+
# If it was installed using conda, run it like this:
38+
rdp_classifier -Xmx8g classify -t /path/to/mydata_trained/rRNAClassifier.properties -o rdp.output query.fasta
39+
# Otherwise run it using java like this:
40+
java -Xmx8g -jar /path/to/rdp_classifier_2.13/classifier.jar -t /path/to/mydata_trained/rRNAClassifier.properties -o rdp.output query.fasta
41+
```
2642

2743
# Releases
2844

@@ -223,4 +239,4 @@ Yilmaz, P., Parfrey, L.W., Yarza, P., Gerken, J., Pruesse, E., Quast, C., et al.
223239

224240
We acknowledge support from the Canadian federal Genomics Research & Development Initiative (GRDI), Metagenomics-Based Ecosystem Biomonitoring (Ecobiomics) project.
225241

226-
Last updated: August 18, 2020
242+
Last updated: March 31, 2021

0 commit comments

Comments
 (0)