← Back to branch summary

~ubuntu-branches/ubuntu/trusty/qiime/trusty

« back to all changes in this revision

Viewing changes to doc/scripts/plot_taxa_summary.rst

  • Committer: Package Import Robot
  • Author(s): Andreas Tille
  • Date: 2013-06-17 18:28:26 UTC
  • mfrom: (9.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20130617182826-376az5ad080a0sfe
Tags: 1.7.0+dfsg-1
Upload preparations done for BioLinux to Debian

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/scripts/plot_taxa_summary.rst
66
66
 
67
67
**Examples:**
68
68
 
69
 
If you wish to run the code using default parameters, you must supply a counts file (Class.txt) along with the taxon level label (Class) and the type(s) of chart, by using the following command:
 
69
If you wish to run the code using default parameters, you must supply a counts file (phylum.txt) along with the taxon level label (Phylum), the type(s) of charts to produce, and an output directory, by using the following command:
70
70
 
71
71
::
72
72
 
73
 
        plot_taxa_summary.py -i Class.txt -l Class -c pie,bar,area
 
73
        plot_taxa_summary.py -i phylum.txt -l phylum -c pie,bar,area -o phylum_charts/
74
74
 
75
75
If you want to make charts for multiple levels at a time (phylum.txt,class.txt,genus.txt) use the following command:
76
76
 
77
77
::
78
78
 
79
 
        plot_taxa_summary.py -i phylum.txt,class.txt,genus.txt -l phylum,class,genus -c pie,bar,area
80
 
 
81
 
If you want specify an output directory (e.g. "output_charts/", regardless of whether the directory exists, use the following command:
82
 
 
83
 
::
84
 
 
85
 
        plot_taxa_summary.py -i Class.txt -l Class -c pie,bar,area -o output_charts/
 
79
        plot_taxa_summary.py -i phylum.txt,class.txt,genus.txt -l Phylum,Class,Genus -c pie,bar,area -o phylum_class_genus_charts/
86
80
 
87
81
Additionally, if you would like to display on a set number of taxa ("-n 10") in the pie charts, you can use the following command:
88
82
 
89
83
::
90
84
 
91
 
        plot_taxa_summary.py -i Class.txt -l Class -c pie -o pie_charts/ -n 10
 
85
        plot_taxa_summary.py -i class.txt -l Class -c pie -n 10 -o class_pie_n10_charts/
92
86
 
93
 
If you would like to display generate pie charts for samples samples: 'sample1' and 'sample2' that are in the counts file header, you can use the following command:
 
87
If you would like to display generate pie charts for specific samples, i.e. sample 'PC.636' and sample 'PC.635' that are in the counts file header, you can use the following command:
94
88
 
95
89
::
96
90
 
97
 
        plot_taxa_summary.py -i Class.txt -l Class -o pie_charts/ -b sample1,sample2
 
91
        plot_taxa_summary.py -i class.txt -l Class -b PC.636,PC.635 -o sample_charts/
98
92
 
99
93