File: obiuniq.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 (79 lines) | stat: -rw-r--r-- 2,407 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.. automodule:: obiuniq


   
   :py:mod:`obiuniq` specific options
   ----------------------------------

   .. cmdoption::  -m <KEY>, --merge=<KEY>   

     Attribute to merge.

     *Example:*
    
        .. code-block:: bash

            > obiuniq -m sample seq1.fasta > seq2.fasta
    
        Dereplicates sequences and keeps the value distribution of the ``sample`` attribute
        in the new attribute ``merged_sample``.

   .. cmdoption::  -i , --merge-ids
       
     Adds a ``merged`` attribute containing the list of sequence record ids merged
     within this group.
   
   .. cmdoption::  -c <KEY>, --category-attribute=<KEY>

     Adds one attribute to the list of attributes used to define sequence groups
     (this option can be used several times).

     *Example:*
    
        .. code-block:: bash

            > obiuniq -c sample seq1.fasta > seq2.fasta
    
        Dereplicates sequences within each sample.

   .. cmdoption::  -p, --prefix
        
     Dereplication is done based on prefix matching:
        
            1. The shortest sequence of each group is a prefix of any sequence of its group
            
            2. The shortest sequence of a group is the prefix of only the sequences belonging
               to its group 


   .. include:: ../optionsSet/taxonomyDB.txt

   .. include:: ../optionsSet/inputformat.txt

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

   :py:mod:`obiuniq` added sequence attributes
   -------------------------------------------

      .. hlist::
           :columns: 3

           - :doc:`count <../attributes/count>`
           - :doc:`merged_* <../attributes/merged_star>`
           - :doc:`merged <../attributes/merged>`
           - :doc:`scientific_name <../attributes/scientific_name>`
           - :doc:`rank <../attributes/rank>`
           - :doc:`family <../attributes/family>`
           - :doc:`family_name <../attributes/family_name>`
           - :doc:`genus <../attributes/genus>`
           - :doc:`genus_name <../attributes/genus_name>`       
           - :doc:`order <../attributes/order>`
           - :doc:`order_name <../attributes/order_name>`
           - :doc:`species <../attributes/species>`
           - :doc:`species_name <../attributes/species_name>`

   :py:mod:`obiuniq` used sequence attribute
   -----------------------------------------

           - :doc:`taxid <../attributes/taxid>`