Skip to content

Commit 7064d10

Browse files
Update README.md
1 parent a385405 commit 7064d10

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,17 @@ mg_classifier assigns a taxonomy to 16S or 18S sequences produced by PCR amplifi
99
### Dependencies
1010
You will need the following scripts in you [PATH](http://www.troubleshooters.com/linux/prepostpath.htm); or just download them and move them to /usr/bin (you will need superuser authorization for this, example: `sudo mv vsearch /usr/bin`.
1111
- To cluster and classify sequences it relies on [vsearch](https://github.com/torognes/vsearch).
12-
- [fastagrep](http://nebc.nerc.ac.uk/nebc_website_frozen/nebc.nerc.ac.uk//tools/code-corner/scripts/sequence-formatting-and-other-text-manipulation.html#-ace_split-pl).
13-
- If you are processing many samples (usual stuff) the script needs another little perl script called compile_classifications.pl.
12+
- [fastagrep](http://nebc.nerc.ac.uk/nebc_website_frozen/nebc.nerc.ac.uk//tools/code-corner/scripts/sequence-formatting-and-other-text-manipulation.html#-ace_split-pl) which is included in the `scripts/ ` subfolder.
13+
- If you are processing many samples (usual stuff) the script needs another little perl script called compile_classifications.pl, also included in the `scripts/ ` subfolder.
1414

15-
Of course, you will also need a database, for the fast processing of data, mg_classifier has to have the database formatted in a certain way.
15+
### Download and install
16+
The best way to get mg_classifier is to clone this repository directly to your linux:
17+
1. Open a terminal and go to your prefered folder.
18+
2. Type `git clone https://github.com/GenomicaMicrob/mg_classifier.git`, this will automatically download all basic files to a new folder called mg_classifier.
19+
3. Make all scripts executable: `chmod +x mgclassifier/mg_classifier.sh mgclassifier/scripts/*.pl`.
20+
3. Download the databases to the created subfolder `databases/` from figshare (soon).
21+
22+
For the fast processing of data, mg_classifier has to have the database formatted in a certain way.
1623

1724
### Database format
1825
The databases have to have the following format:

0 commit comments

Comments
 (0)