← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/scripts/parallel_beta_diversity.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/parallel_beta_diversity.rst
30
30
                Beta-diversity metric(s) to use. A comma-separated list should be provided when multiple metrics are specified. [default: unweighted_unifrac,weighted_unifrac]
31
31
        -t, `-`-tree_path
32
32
                Path to newick tree file, required for phylogenetic metrics [default: None]
33
 
        -N, `-`-beta_diversity_fp
34
 
                Full path to scripts/`beta_diversity.py <./beta_diversity.html>`_ [default: $HOME/qiime_software/scripts/`beta_diversity.py <./beta_diversity.html>`_]
35
 
        -P, `-`-poller_fp
36
 
                Full path to qiime/parallel/`poller.py <./poller.html>`_ [default: $HOME/qiime_software/scripts/`poller.py <./poller.html>`_]
37
33
        -R, `-`-retain_temp_files
38
34
                Retain temporary files after runs complete (useful for debugging) [default: False]
39
35
        -S, `-`-suppress_submit_jobs
41
37
        -T, `-`-poll_directly
42
38
                Poll directly for job completion rather than running poller as a separate job. If -T is specified this script will not return until all jobs have completed. [default: False]
43
39
        -U, `-`-cluster_jobs_fp
44
 
                Path to cluster jobs script (defined in qiime_config)  [default: $HOME/qiime_software/scripts/`start_parallel_jobs.py <./start_parallel_jobs.html>`_]
 
40
                Path to cluster jobs script (defined in qiime_config)  [default: `start_parallel_jobs.py <./start_parallel_jobs.html>`_]
45
41
        -W, `-`-suppress_polling
46
42
                Suppress polling of jobs and merging of results upon completion [default: False]
47
43
        -X, `-`-job_prefix
48
44
                Job prefix [default: descriptive prefix + random chars]
49
 
        -Y, `-`-python_exe_fp
50
 
                Full path to python executable [default: /usr/local/bin/python2.7]
51
45
        -Z, `-`-seconds_to_sleep
52
 
                Number of seconds to sleep between checks for run  completion when polling runs [default: 60]
 
46
                Number of seconds to sleep between checks for run  completion when polling runs [default: 1]
53
47
        -O, `-`-jobs_to_start
54
48
                Number of jobs to start [default: 2]
55
49
        -f, `-`-full_tree
58
52
 
59
53
**Output:**
60
54
 
61
 
The output of %prog is a folder containing text files, each a distance matrix between samples.
62
 
 
63
 
 
64
 
**Apply beta_diversity.py in parallel:**
 
55
The output of parallel_beta_diversity.py is a folder containing text files, each a distance matrix between samples.
 
56
 
 
57
 
 
58
**Apply beta_diversity.py in parallel to multiple otu tables:**
65
59
 
66
60
Apply the unweighted_unifrac and weighted_unifrac metrics (modify with -m) to all otu tables in rarefied_otu_tables (-i) and write the resulting output files to bdiv/ (-o, will be created if it doesn't exist). Use the rep_set.tre (-t) to compute phylogenetic diversity metrics. ALWAYS SPECIFY ABSOLUTE FILE PATHS (absolute path represented here as $PWD, but will generally look something like /home/ubuntu/my_analysis/).
67
61
 
69
63
 
70
64
        parallel_beta_diversity.py -i $PWD/rarefied_otu_tables/ -o $PWD/bdiv/ -t $PWD/rep_set.tre
71
65
 
 
66
**Apply beta_diversity.py in parallel to a single otu table:**
 
67
 
 
68
 
 
69
 
 
70
::
 
71
 
 
72
        parallel_beta_diversity.py -i $PWD/otu_table.biom -o $PWD/bdiv_single/ -t $PWD/rep_set.tre
 
73
 
72
74