File: make_per_library_sff.rst

package info (click to toggle)
qiime 1.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 29,704 kB
  • sloc: python: 77,837; haskell: 379; sh: 113; makefile: 103
file content (53 lines) | stat: -rw-r--r-- 1,625 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
.. _make_per_library_sff:

.. index:: make_per_library_sff.py

*make_per_library_sff.py* -- Make per-library sff files from ID lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Description:**

This script generates per-library sff files using a directory of text files, one per library, which list read ID's to be included.

The ID list files should contain one read ID per line. If a line contains multiple words (separated by whitespace), then only the first word is used. A '>' character is stripped from the beginning of the line, if present. Blank lines in the file are skipped.



**Usage:** :file:`make_per_library_sff.py [options]`

**Input Arguments:**

.. note::

	
	**[REQUIRED]**
		
	-i, `-`-input_sff
		Input sff file (separate multiple files w/ comma)
	-l, `-`-libdir
		Directory containing ID list text files, one per library
	
	**[OPTIONAL]**
		
	-p, `-`-sfffile_path
		Path to sfffile binary [default: use sfffile in $PATH]
	`-`-use_sfftools
		Use external sfffile program instead of equivalent Python routines.
	`-`-debug
		Print debugging output to stdout [default: False]


**Output:**

The result of this script generates sff files for each library.


**Example:**

Make per-library sff files using input.sff and a directory of libs where each file in the directory contains the id lists for each library:

::

	make_per_library_sff.py -i input.sff -l libs