Mercurial > repos > kkonganti > cfsan_centriflaken
annotate 0.3.0/modules/cat/tables/README.md @ 92:295c2597a475
"planemo upload"
| author | kkonganti |
|---|---|
| date | Tue, 19 Jul 2022 10:07:24 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| kkonganti@92 | 1 # NextFlow DSL2 Module |
| kkonganti@92 | 2 |
| kkonganti@92 | 3 ```bash |
| kkonganti@92 | 4 TABLE_SUMMARY |
| kkonganti@92 | 5 ``` |
| kkonganti@92 | 6 |
| kkonganti@92 | 7 ## Description |
| kkonganti@92 | 8 |
| kkonganti@92 | 9 Concatenates a list of tables (CSV or TAB delimited) in `.txt` or `.csv` format. The table files to be concatenated **must** have a header as the header from one of the table files will be used as the header for the concatenated result table file. |
| kkonganti@92 | 10 |
| kkonganti@92 | 11 \ |
| kkonganti@92 | 12 |
| kkonganti@92 | 13 |
| kkonganti@92 | 14 ### `input:` |
| kkonganti@92 | 15 |
| kkonganti@92 | 16 ___ |
| kkonganti@92 | 17 |
| kkonganti@92 | 18 Type: `tuple` |
| kkonganti@92 | 19 |
| kkonganti@92 | 20 Takes in the following tuple of `val` table key (`table_sum_on`) and a list of table files of input type `path` (`tables`) to be concatenated. For this module to work, a `bin` directory with the script `create_mqc_data_table.py` should be present where the NextFlow script using this DSL2 module will be run. This `python` script will convert the aggregated table to `.yml` format to be used with `multiqc`. |
| kkonganti@92 | 21 |
| kkonganti@92 | 22 Ex: |
| kkonganti@92 | 23 |
| kkonganti@92 | 24 ```groovy |
| kkonganti@92 | 25 [ ['ectyper'], ['/data/sample1/f1_ectyper.txt', '/data/sample2/f2_ectyper.txt'] ] |
| kkonganti@92 | 26 ``` |
| kkonganti@92 | 27 |
| kkonganti@92 | 28 \ |
| kkonganti@92 | 29 |
| kkonganti@92 | 30 |
| kkonganti@92 | 31 #### `table_sum_on` |
| kkonganti@92 | 32 |
| kkonganti@92 | 33 Type: `val` |
| kkonganti@92 | 34 |
| kkonganti@92 | 35 A single key defining what tables are being concatenated. For example, if all the `ectyper` results are being concatenated for all samples, then this can be `ectyper`. |
| kkonganti@92 | 36 |
| kkonganti@92 | 37 Ex: |
| kkonganti@92 | 38 |
| kkonganti@92 | 39 ```groovy |
| kkonganti@92 | 40 [ ['ectyper'], ['/data/sample1/f1_ectyper.txt', '/data/sample2/f2_ectyper.txt'] ] |
| kkonganti@92 | 41 ``` |
| kkonganti@92 | 42 |
| kkonganti@92 | 43 \ |
| kkonganti@92 | 44 |
| kkonganti@92 | 45 |
| kkonganti@92 | 46 #### `tables` |
| kkonganti@92 | 47 |
| kkonganti@92 | 48 Type: `path` |
| kkonganti@92 | 49 |
| kkonganti@92 | 50 NextFlow input type of `path` pointing to a list of tables (files) to be concatenated. |
| kkonganti@92 | 51 |
| kkonganti@92 | 52 \ |
| kkonganti@92 | 53 |
| kkonganti@92 | 54 |
| kkonganti@92 | 55 ### `output:` |
| kkonganti@92 | 56 |
| kkonganti@92 | 57 ___ |
| kkonganti@92 | 58 |
| kkonganti@92 | 59 Type: `tuple` |
| kkonganti@92 | 60 |
| kkonganti@92 | 61 Outputs a tuple of table key (`table_sum_on` from `input:`) and list of concatenated table files (`tblsummed`). |
| kkonganti@92 | 62 |
| kkonganti@92 | 63 \ |
| kkonganti@92 | 64 |
| kkonganti@92 | 65 |
| kkonganti@92 | 66 #### `tblsummed` |
| kkonganti@92 | 67 |
| kkonganti@92 | 68 Type: `path` |
| kkonganti@92 | 69 |
| kkonganti@92 | 70 NextFlow output type of `path` pointing to the concatenated table files per table key (Ex: `ectyper`). |
| kkonganti@92 | 71 |
| kkonganti@92 | 72 \ |
| kkonganti@92 | 73 |
| kkonganti@92 | 74 |
| kkonganti@92 | 75 #### `mqc_yml` |
| kkonganti@92 | 76 |
| kkonganti@92 | 77 Type: `path` |
| kkonganti@92 | 78 |
| kkonganti@92 | 79 NextFlow output type of `path` pointing to the `.yml` file storing table contents in `YAML` format which can be used to inject this table as part of the `multiqc` report. |
| kkonganti@92 | 80 |
| kkonganti@92 | 81 \ |
| kkonganti@92 | 82 |
| kkonganti@92 | 83 |
| kkonganti@92 | 84 #### `versions` |
| kkonganti@92 | 85 |
| kkonganti@92 | 86 Type: `path` |
| kkonganti@92 | 87 |
| kkonganti@92 | 88 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |