File: obitab.rst

package info (click to toggle)
obitools 1.2.13%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 4,652 kB
  • sloc: python: 18,199; ansic: 1,542; makefile: 98
file content (48 lines) | stat: -rw-r--r-- 1,584 bytes parent folder | download | duplicates (3)
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
.. automodule:: obitab
   
   
    :py:mod:`obitab` specific options
    ---------------------------------   

    .. cmdoption::   -n <NOT AVAILABLE STRING>, --na-string=<NOT AVAILABLE STRING>
   
                   String written in the table for the not available values 
                   (default value ``NA``).
                   
    .. cmdoption::    --output-field-separator=<STRING>
   
                   Field separator for the tabular file 
                   (default value ``TAB``).
                   
    .. cmdoption::    -o, --output-seq      
   
                   Adds an extra column at the end of the table for 
                   the sequence itself.
                   
    .. cmdoption::    -d, --no-definition   
   
                   Removes column containing the sequence definition in
                   the output tab file.
                   
    .. cmdoption::    -a <KEY>, --omit-attribute=<KEY>
   
                   Attributes whose key is in this list will not be printed in 
                   the output tab file.  
                        
    .. include:: ../optionsSet/inputformat.txt

    .. include:: ../optionsSet/defaultoptions.txt



    Example
    -------
        
        .. code-block:: bash
            
              > obitab -d -o seq1.fasta > seq1.txt
        
        Reformats all sequence records present in the ``seq1.fasta`` file 
        into a tabular file without outputing the sequence definition but
        with an extra column containing the sequence itself. The result is
        stored in the ``seq1.txt`` file.