← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/scripts/pick_closed_reference_otus.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/pick_closed_reference_otus.rst
 
1
.. _pick_closed_reference_otus:
 
2
 
 
3
.. index:: pick_closed_reference_otus.py
 
4
 
 
5
*pick_closed_reference_otus.py* -- Closed-reference OTU picking/Shotgun UniFrac workflow.
 
6
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
7
 
 
8
**Description:**
 
9
 
 
10
This script picks OTUs using a closed reference and constructs an OTU table. Taxonomy is assigned using a pre-defined taxonomy map of reference sequence OTU to taxonomy. If full-length genomes are provided as the reference sequences, this script applies the Shotgun UniFrac method.
 
11
 
 
12
 
 
13
**Usage:** :file:`pick_closed_reference_otus.py [options]`
 
14
 
 
15
**Input Arguments:**
 
16
 
 
17
.. note::
 
18
 
 
19
        
 
20
        **[REQUIRED]**
 
21
                
 
22
        -i, `-`-input_fp
 
23
                The input sequences
 
24
        -r, `-`-reference_fp
 
25
                The reference sequences
 
26
        -o, `-`-output_dir
 
27
                The output directory
 
28
        
 
29
        **[OPTIONAL]**
 
30
                
 
31
        -p, `-`-parameter_fp
 
32
                Path to the parameter file, which specifies changes to the default behavior. See http://www.qiime.org/documentation/file_formats.html#qiime-parameters . [if omitted, default values will be used]
 
33
        -t, `-`-taxonomy_fp
 
34
                The taxonomy map [default: None]
 
35
        -f, `-`-force
 
36
                Force overwrite of existing output directory (note: existing files in output_dir will not be removed) [default: None]
 
37
        -w, `-`-print_only
 
38
                Print the commands but don't call them -- useful for debugging [default: False]
 
39
        -a, `-`-parallel
 
40
                Run in parallel where available [default: False]
 
41
        -O, `-`-jobs_to_start
 
42
                Number of jobs to start. NOTE: you must also pass -a to run in parallel, this defines the number of jobs to be started if and only if -a is passed [default: 2]
 
43
 
 
44
 
 
45
**Output:**
 
46
 
 
47
 
 
48
 
 
49
 
 
50
Pick OTUs, assign taxonomy, and create an OTU table against a reference set of OTUs. ALWAYS SPECIFY ABSOLUTE FILE PATHS (absolute path represented here as $PWD, but will generally look something like /home/ubuntu/my_analysis/).
 
51
 
 
52
::
 
53
 
 
54
        pick_closed_reference_otus.py -i $PWD/seqs.fna -r $PWD/refseqs.fna -o $PWD/otus_w_tax/ -t $PWD/taxa.txt
 
55
 
 
56
Pick OTUs and create an OTU table against a reference set of OTUs without adding taxonomy assignments. ALWAYS SPECIFY ABSOLUTE FILE PATHS (absolute path represented here as $PWD, but will generally look something like /home/ubuntu/my_analysis/).
 
57
 
 
58
::
 
59
 
 
60
        pick_closed_reference_otus.py -i $PWD/seqs.fna -r $PWD/refseqs.fna -o $PWD/otus/
 
61
 
 
62
Pick OTUs, assign taxonomy, and create an OTU table against a reference set of OTUs using usearch_ref. ALWAYS SPECIFY ABSOLUTE FILE PATHS (absolute path represented here as $PWD, but will generally look something like /home/ubuntu/my_analysis/).
 
63
 
 
64
::
 
65
 
 
66
        pick_closed_reference_otus.py -i $PWD/seqs.fna -r $PWD/refseqs.fna -o $PWD/otus_usearch/ -p $PWD/usearch_params.txt -t $PWD/taxa.txt
 
67
 
 
68