You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browse filesBrowse the repository at this point in the historyBrowse files
authored
Updating tools/rcx-tk from version 0.2.2 to 0.3.1 (#767)
* Updating tools/rcx-tk from version 0.2.2 to 0.3.1
* updated command section to comply with 0.3.1
---------
Co-authored-by: planemo-autoupdate <planemo-autoupdate@users.noreply.github.com>
Co-authored-by: Helge Hecht <helge.hecht@recetox.muni.cz>
<paramname="input_file"type="data"format="csv,tabular,tsv,xls,xlsx,txt"label="Input data file"help="Upload your sample sequence or alkane file."/>
26
-
<paramname="method"type="select"label="Processing method"help="Select whether to process a sequence file or an alkane file. This determines the column arrangement and validation steps.">
<paramname="input_file"type="data"format="csv,tabular,tsv,xls,xlsx,txt"label="Input data file"help="Upload your sample sequence, alkane, or MS-DIAL file."/>
30
+
<conditionalname="command">
31
+
<paramname="method"type="select"label="Processing method"help="Select the rcx-tk subcommand to run. This determines the column arrangement, validation steps, and CLI invocation.">
<paramargument="mz_tol_ppm"type="integer"min="1"max="100"value="5"label="m/z tolerance [ppm]"help="Tolerance for splitting clusters from different ions." />
40
+
</when>
41
+
</conditional>
42
+
31
43
</inputs>
32
44
<outputs>
33
45
<dataname="output_file"format="tabular" from_work_dir = "output.tsv"label="Processed as ${method} on dataset ${input_file.id}"/>
rcx-tk is a tool for processing sample sequence and alkane files. It standardizes your input by rearranging columns, validating file names, and deriving new columns such as `sampleName`, `sequenceIdentifier`, `sampleIdentifier`, and `localOrder`. This ensures your data is ready for downstream analysis and compatible with standardized workflows.
74
+
rcx-tk is a tool for processing sequence metadata, alkane retention index, and MS-DIAL output files. It standardizes inputs by rearranging columns, validating file names, and deriving new columns such as `sampleName`, `sequenceIdentifier`, `subjectIdentifier`, and `localOrder`. For MS-DIAL files, it also merges duplicate alignments using the package's click-based subcommand interface.
63
75
64
76
How it works
65
77
------------
66
78
67
-
- **Column rearrangement**: Ensures columns are in the correct order for further processing.
68
-
- **File name validation**: Checks that file names follow expected conventions.
69
-
- **Derivation of new columns**: Automatically generates useful columns for sample tracking and analysis.
79
+
- **Sequence files**: validates file names, checks that `injectionOrder` is an integer, and derives metadata columns from the file name.
80
+
- **Alkane files**: keeps the alkane columns used by rcx-tk and renames them to the normalized output format.
81
+
- **MS-DIAL files**: reads the MS-DIAL table, identifies duplicate alignments, and refines them using the tolerance value.
70
82
71
83
Inputs
72
84
------
73
85
74
86
1. **Input data file**
75
-
Upload your sample sequenceor alkane file. Supported formats: CSV, TSV, tabular, XLS, XLSX, or TXT.
87
+
Upload your sample sequence, alkane, or MS-DIAL file. Supported formats: CSV, TSV, tabular, XLS, XLSX, or TXT.
76
88
77
89
2. **Processing method**
78
-
Select whether to process a sequence file or an alkane file. This determines the column arrangement and validation steps.
90
+
Select which rcx-tk subcommand to run. This determines the column arrangement, validation steps, and whether MS-DIAL duplicate merging is applied.
91
+
92
+
3. **MS-DIAL tolerance**
93
+
When processing MS-DIAL files, you can provide an optional m/z tolerance in parts per million. The default used by rcx-tk is 5.
79
94
80
95
Outputs
81
96
-------
@@ -86,7 +101,7 @@ Outputs
86
101
Example
87
102
-------
88
103
89
-
Suppose you have a sequence file in CSV or tabular format. Select "Sequence file" as the processing method and upload your file. The tool will output a processed TSV file with standardized columns and additional identifiers.
104
+
Suppose you have a sequence file in CSV or tabular format. Select "Sequence file" as the processing method and upload your file. The tool will output a processed TSV file with standardized columns and additional identifiers. For MS-DIAL files, the tool invokes the `msdial` subcommand with the package's default tolerance unless you extend the wrapper to expose that argument.
0 commit comments