← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/scripts/check_id_map.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/check_id_map.rst
28
28
       barcodes are appended (error)
29
29
    - There are no duplicates when barcodes and added demultiplex 
30
30
       fields (-j option) are combined (error)
31
 
    - Data fields are not found passed the Description column (warning)
 
31
    - Data fields are not found beyond the Description column (warning)
32
32
      
33
33
    Details about the metadata mapping file format can be found here:
34
34
    http://www.qiime.org/documentation/file_formats.html#metadata-mapping-files
35
35
    
36
 
    Errors and warnings are saved to a log file.  Errors are generally caused 
37
 
    by problems with the headers, and should be resolved before attempting to 
38
 
    correct any warnings.  Duplicate SampleIDs will also create errors.
 
36
    Errors and warnings are saved to a log file.  Errors can be caused by
 
37
    problems with the headers, invalid characters in barcodes or primers, or
 
38
    by duplications in SampleIDs or barcodes.
39
39
    
40
 
    Warnings can arise from invalid characters, non-DNA characters,
41
 
    duplicate sample descriptions/barcodes, or missing data fields.
 
40
    Warnings can arise from invalid characters and variable length barcodes that
 
41
    are not specified with the --variable_len_barcode.
42
42
    Warnings will contain a reference to the cell (row,column) that the 
43
43
    warning arose from.
44
44
    
71
71
        **[REQUIRED]**
72
72
                
73
73
        -m, `-`-mapping_fp
74
 
                Metadata mapping file filepath
 
74
                Metadata mapping filepath
75
75
        
76
76
        **[OPTIONAL]**
77
77
                
78
78
        -o, `-`-output_dir
79
 
                Required output directory for log file and corrected mapping file, log file, and html file. [default: ./]
 
79
                Required output directory for log file, corrected mapping file, and html file. [default: ./]
80
80
        -v, `-`-verbose
81
81
                Enable printing information to standard out [default: True]
82
82
        -c, `-`-char_replace
83
83
                Changes the default character used to replace invalid characters found in the mapping file.  Must be a valid character (alphanumeric, period, or underscore).[default: _]
84
84
        -b, `-`-not_barcoded
85
 
                Use -b if barcodes are not present. [default: False]
 
85
                Use -b if barcodes are not present.  BarcodeSequence header still required.  [default: False]
86
86
        -B, `-`-variable_len_barcodes
87
87
                Use -B if variable length barcodes are present to suppress warnings about barcodes of unequal length. [default: False]
88
88
        -p, `-`-disable_primer_check
89
 
                Use -p to disable checks for primers. [default: False]
 
89
                Use -p to disable checks for primers.  LinkerPrimerSequence header still required.  [default: False]
90
90
        -j, `-`-added_demultiplex_field
91
 
                Use -j to add a field to use in the mapping file as an additional demultiplexing option to the barcode.  All combinations of barcodes/primers and the these fields must be unique. The fields must contain values that can be parsed from the fasta labels such as "plate=R_2008_12_09".  In this case, "plate" would be the column header and "R_2008_12_09" would be the field data (minus quotes) in the mapping file.  To use the run prefix from the fasta label, such as ">FLP3FBN01ELBSX", where "FLP3FBN01" is generated from the run ID, use "-j run_prefix" and set the run prefix to be used as the data under the column header "run_prefix".  [default: None]
 
91
                Use -j to add a field to use in the mapping file as additional demultiplexing (can be used with or without barcodes).  All combinations of barcodes/primers and the these fields must be unique. The fields must contain values that can be parsed from the fasta labels such as "plate=R_2008_12_09".  In this case, "plate" would be the column header and "R_2008_12_09" would be the field data (minus quotes) in the mapping file.  To use the run prefix from the fasta label, such as ">FLP3FBN01ELBSX", where "FLP3FBN01" is generated from the run ID, use "-j run_prefix" and set the run prefix to be used as the data under the column header "run_prefix".  [default: None]
 
92
        -s, `-`-suppress_html
 
93
                Use -s to disable html file generation, can be useful for extremely large mapping files. [default: False]
92
94
 
93
95
 
94
96
**Output:**
95
97
 
96
 
A log file, html file, and corrected_mapping.txt file will be written to the current directory directory.
 
98
A log file, html file, and corrected_mapping.txt file will be written to the current output directory.
97
99
 
98
100
 
99
101
**Example:**
100
102
 
101
 
Check the test_mapping.txt mapping file for problems, supplying the required mapping file.
 
103
Check the Fasting_Map.txt mapping file for problems, supplying the required mapping file, and output the results in the check_id_map_output directory
102
104
 
103
105
::
104
106
 
105
 
        check_id_map.py -m test_mapping.txt
 
107
        check_id_map.py -m Fasting_Map.txt -o check_id_map_output
106
108
 
107
109