Mercurial > repos > kkonganti > cfsan_centriflaken

comparison 0.3.0/modules/centrifuge/process/README.md @ 92:295c2597a475

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload"
author kkonganti
date Tue, 19 Jul 2022 10:07:24 -0400
parents
children
comparison
equal deleted inserted replaced
91:046e57368d3b 92:295c2597a475
1 # NextFlow DSL2 Module
2
3 ```bash
4 CENTRIFUGE_PROCESS
5 ```
6
7 ## Description
8
9 Extract FASTQ reads given a FASTQ file originally used with `centrifuge` tool and a taxa of interest. This specific module uses a `python` script to generate the FASTQ read ids and as such requires a `bin` folder with `process_centrifuge_output.py` to be present where the NextFlow script will be executed from. See also `CENTRIFUGE_EXTRACT` module which uses only GNU Coreutils to create a list of FASTQ read ids that need to be extracted.
10
11 \
12  
13
14 ### `input:`
15
16 ___
17
18 Type: `tuple`
19
20 Takes in a tuple in order of metadata (`meta`), a `path` (`centrifuge_report`) type and another `path` (`centrifuge_report`) per sample (`id:`).
21
22 Ex:
23
24 ```groovy
25 [
26 [ id: 'FAL00870',
27 strandedness: 'unstranded',
28 single_end: true,
29 centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab'
30 ],
31 '/hpc/scratch/test/FAL000870/f1.merged.cent_out.report.txt',
32 '/hpc/scratch/test/FAL000870/f1.merged.cent_out.output.txt'
33 ]
34 ```
35
36 \
37  
38
39 #### `meta`
40
41 Type: Groovy Map
42
43 A Groovy Map containing the metadata about the FASTQ file.
44
45 Ex:
46
47 ```groovy
48 [
49 id: 'FAL00870',
50 strandedness: 'unstranded',
51 single_end: true,
52 centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab'
53 ]
54 ```
55
56 \
57  
58
59 #### `centrifuge_report`
60
61 Type: `path`
62
63 NextFlow input type of `path` pointing to `centrifuge` report file generated using `--report-file` option of `centrifuge` tool.
64
65 \
66  
67
68 #### `centrifuge_output`
69
70 Type: `path`
71
72 NextFlow input type of `path` pointing to `centrifuge` output file generated using `-S` option of `centrifuge` tool.
73
74 \
75  
76
77 ### `output:`
78
79 ___
80
81 Type: `tuple`
82
83 Outputs a tuple of metadata (`meta` from `input:`) and list of extracted FASTQ read ids.
84
85 \
86  
87
88 #### `extracted`
89
90 Type: `path`
91
92 NextFlow output type of `path` pointing to the extracted FASTQ read ids belonging to a particular taxa (`*.extract-centrifuge-bug-ids.txt`).
93
94 \
95  
96
97 #### `versions`
98
99 Type: `path`
100
101 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.