parallel_multiple_rarefactions.py – Parallel multiple file rarefaction

Description:

This script performs like the multiple_rarefactions.py script, but is intended to make use of multicore/multiprocessor environments to perform analyses in parallel.

Usage: parallel_multiple_rarefactions.py [options]

Input Arguments:

Note

[REQUIRED]

-i, --input_path

Input filepath, (the otu table) [REQUIRED]

-o, --output_path

Write output rarefied otu tables here makes dir if it doesn’t exist [REQUIRED]

-m, --min

Min seqs/sample [REQUIRED]

-x, --max

Max seqs/sample (inclusive) [REQUIRED]

-s, --step

Levels: min, min+step... for level <= max [REQUIRED]

[OPTIONAL]

-n, --num-reps

Num iterations at each seqs/sample level [default: 10]

--lineages_included

Output rarefied otu tables will include taxonomic (lineage) information for each otu, if present in input otu table [default: False]

-N, --single_rarefaction_fp

Full path to scripts/single_rarefaction.py [default: /Users/caporaso/code/Qiime/scripts/single_rarefaction.py]

-P, --poller_fp

Full path to qiime/parallel/poller.py [default: /Users/caporaso/code/Qiime/scripts/poller.py]

-R, --retain_temp_files

Retain temporary files after runs complete (useful for debugging) [default: False]

-S, --suppress_submit_jobs

Only split input and write commands file - don’t submit jobs [default: False]

-T, --poll_directly

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]

-U, --cluster_jobs_fp

Path to cluster jobs script (defined in qiime_config) [default: /Users/caporaso/code/Qiime/scripts/start_parallel_jobs.py]

-W, --suppress_polling

Suppress polling of jobs and merging of results upon completion [default: False]

-X, --job_prefix

Job prefix [default: descriptive prefix + random chars]

-Y, --python_exe_fp

Full path to python executable [default: python]

-Z, --seconds_to_sleep

Number of seconds to sleep between checks for run completion when polling runs [default: 6]

-O, --jobs_to_start

Number of jobs to start [default: 2]

Output:

The result of parallel_multiple_rarefactions.py consists of a number of files, which depend on the minimum/maximum number of sequences per samples, steps and iterations. The files have the same otu table format as the input otu_table.txt, and are named in the following way: rarefaction_100_0.txt, where “100” corresponds to the sequences per sample and “0” for the iteration.

Example:

Build rarefied otu tables containing 100 (-m) to 2000 (-x) sequences in steps of 100 (-s) with 5 (-n) repetions per number of sequences, from /home/qiime_user/otu_table.txt (-i). Write the output files to the /home/qiime_user/rare directory (-o, will be created if it doesn’t exist). The name of the output files will be of the form /home/qiime_user/rare/rarefaction_<num_seqs>_<reptition_number>.txt

parallel_multiple_rarefactions.py -o /home/qiime_user/rare -m 100 -x 2000 -s 100 -n 5 -i /home/qiime_user/otu_table.txt