@@ -5,7 +5,28 @@ GTNet comes with multiple commands. The simplest way of running GTNet is to use
55
66.. code :: bash
77
8- gtnet classify data/small.fna > data/small.tax.csv
8+ gtnet classify genome.fna > genome.tax.csv
9+
10+ This command generates one classification for the entire file, and should be used to get classification for metagenome bin.
11+ Use the ``-s/--seqs `` flag to get classifications for the individual sequences in ``genome.fna ``
12+
13+ .. Attention ::
14+ The first time you run ``classify `` and ``predict `` (see below), the model file will be downloaded and stored in the same
15+ directory that the *gtnet * package is installed in. Therefore, for the this to be successful, you must have write privileges
16+ on the directory that *gtnet * is installed in.
17+
18+
19+ .. code :: bash
20+
21+ gtnet classify --seqs genome.fna > genome.seqs.tax.csv
22+
23+
24+ The ``classify `` command can take multiple fasta files, and will produce line per file in the output. For example, the following
25+ command will contain two lines:
26+
27+ .. code :: bash
28+
29+ gtnet classify bin1.fna bin2.fna > bins.tax.csv
930
1031
1132 GTNet steps
@@ -18,15 +39,12 @@ want to experiment with different false-positive rates.
1839Getting predictions
1940^^^^^^^^^^^^^^^^^^^
2041
21- To get predictinos for all sequences in a Fasta file, use the ``predict `` subcommand.
42+ To get predictinos for all sequences in a Fasta file, use the ``predict `` subcommand. This command also accepts multiple fasta files
43+ and the ``-s/--seqs `` argument for getting predictions for individual sequences.
2244
2345.. code :: bash
2446
25- gtnet predict data/small.fna > data/small.tax.raw.csv
26-
27- The first time you run ``predict ``, the model file will be downloaded and stored in the
28- same directory that the *gtnet * package is installed in. Therefore, for the this to be successful,
29- you must have write privileges on the directory that *gtnet * is installed in.
47+ gtnet predict genome.fna > genome.tax.raw.csv
3048
3149 Filtering predictions
3250^^^^^^^^^^^^^^^^^^^^^
@@ -36,8 +54,9 @@ to a desired false-positive rate.
3654
3755.. code :: bash
3856
39- gtnet filter --fpr 0.05 data/small .tax.raw.csv > data/small .tax.csv
57+ gtnet filter --fpr 0.05 genome .tax.raw.csv > genome .tax.csv
4058
59+ The ``filter `` command supports predictions for whole files and individual sequences.
4160
4261GPU acceleration
4362----------------
0 commit comments