File: obiclean.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 (63 lines) | stat: -rw-r--r-- 2,285 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
.. automodule:: obiclean

   :py:mod:`obiclean` specific options
   -----------------------------------  

   .. cmdoption::  -d <INTEGER>, --distance=<INTEGER>   
   
                   Maximum numbers of differences between two variant sequences (default: 1).

   .. cmdoption::  -s <KEY>, --sample=<KEY>  
   
                   Attribute containing sample descriptions.

   .. cmdoption::  -r <FLOAT>, --ratio=<FLOAT>  
   
                   Threshold ratio between counts (rare/abundant counts) of two sequence records 
                   so that the less abundant one is a variant of the more abundant
                   (default: 1, i.e. all less abundant sequences are variants).

   .. cmdoption::  -C, --cluster  
   
                   Switch :py:mod:`obiclean` into its clustering mode. This adds information
                   to each sequence about the true.

   .. cmdoption::  -H, --head  
   
                   Select only sequences with the head status in a least one sample.


   .. cmdoption::  -g, --graph  
   
                   Creates a file containing the set of DAG used by the obiclean clustering algorithm.
                   The graph file follows the `dot` format

   .. include:: ../optionsSet/inputformat.txt
    
   .. include:: ../optionsSet/outputformat.txt
    
   .. include:: ../optionsSet/defaultoptions.txt

   :py:mod:`obiclean` used sequence attributes
   -----------------------------------------------

      .. hlist::
           :columns: 3

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

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

      .. hlist::
           :columns: 3

           - :doc:`obiclean_cluster <../attributes/obiclean_cluster>`
           - :doc:`obiclean_count <../attributes/obiclean_count>`
           - :doc:`obiclean_head <../attributes/obiclean_head>`
           - :doc:`obiclean_headcount <../attributes/obiclean_headcount>`
           - :doc:`obiclean_internalcount <../attributes/obiclean_internalcount>`
           - :doc:`obiclean_samplecount <../attributes/obiclean_samplecount>`
           - :doc:`obiclean_singletoncount <../attributes/obiclean_singletoncount>`
           - :doc:`obiclean_status <../attributes/obiclean_status>`