Skip to content

Commit 5c9983e

Browse files
authored
Merge pull request #737 from RECETOX/copilot/update-to-version-0-2-0
rcx-tk: 0.1.0 → 0.2.0, rename metadata→sequence, add msdial corrections tool
2 parents 27a7625 + b9ac8bd commit 5c9983e

File tree

3 files changed

+46
-38
lines changed

3 files changed

+46
-38
lines changed

tools/rcx-tk/.shed.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
name: rcx_tk
21
owner: recetox
32
remote_repository_url: "https://github.com/RECETOX/galaxytools/tree/master/tools/rcx-tk/"
43
homepage_url: "https://github.com/RECETOX/rcx-tk"
54
categories:
65
- Metabolomics
7-
description: "Tools to process metadata or alkane files."
8-
long_description: "rcx-tk package provides tools to process the metadata or alkane files. On the input, the user is expected to supply a path to the metadata/alkane file in tsv/csv/xls/xlsx file. The file is then converted to a dataframe which is further processed. The main steps are columns rearrangement, validation of the file names and derivation of new metadata: sampleName, sequenceIdentifier, sampleIdentifier and localOrder. Finally, the processed dataframe is saved into user-defined location."
9-
type: unrestricted
6+
name: rcx_tk
7+
description: "Tools to process sequence or alkane files and to correct MSDial alignment results by grouping duplicate alignments."
8+
long_description: |
9+
"rcx-tk package provides tools to process the sequence or alkane files. On the input, the user is expected to supply a path to the sequence/alkane file in tsv/csv/xls/xlsx file. The file is then converted to a dataframe which is further processed. The main steps are columns rearrangement, validation of the file names and derivation of new metadata: sampleName, sequenceIdentifier, sampleIdentifier and localOrder. Duplicate rows sharing identical non-zero abundance values in any sample column are clustered and aggregated: metadata is concatenated and abundances are reduced using the maximum value."
10+
type: unrestricted

tools/rcx-tk/macros.xml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<macros>
2+
<token name="@TOOL_VERSION@">0.2.0</token>
3+
<xml name="creator">
4+
<creator>
5+
<person
6+
givenName="Zargham"
7+
familyName="Ahmad"
8+
url="https://github.com/zargham-ahmad"
9+
identifier="0000-0000-0000-0000"/>
10+
<person
11+
givenName="Kristina"
12+
familyName="Gomoryova"
13+
url="https://github.com/KristinaGomoryova"
14+
identifier="0000-0003-4407-3917" />
15+
<person
16+
givenName="Helge"
17+
familyName="Hecht"
18+
url="https://github.com/hechth"
19+
identifier="0000-0001-6744-996X" />
20+
<organization
21+
url="https://www.recetox.muni.cz/"
22+
email="GalaxyToolsDevelopmentandDeployment@space.muni.cz"
23+
name="RECETOX MUNI" />
24+
</creator>
25+
</xml>
26+
</macros>

tools/rcx-tk/rcx-tk.xml

Lines changed: 15 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
<tool id="rcx-tk" name="rcx-tk" version="@TOOL_VERSION@+galaxy1" profile="23.05">
2-
<description>Processes and standardizes metadata or alkane files by rearranging columns, validating file names, and deriving new columns for downstream analysis.</description>
1+
<tool id="rcx-tk" name="rcx-tk" version="@TOOL_VERSION@+galaxy0" profile="23.05">
2+
<description>Processes and standardizes sequence, alkane or MSDial output files for downstream analysis.</description>
33
<macros>
4-
<token name="@TOOL_VERSION@">0.1.0</token>
4+
<import>macros.xml</import>
55
</macros>
66
<edam_topics>
77
<edam_topic>topic_3172</edam_topic>
@@ -15,27 +15,7 @@
1515
<requirements>
1616
<requirement type="package" version="@TOOL_VERSION@">rcx-tk</requirement>
1717
</requirements>
18-
<creator>
19-
<person
20-
givenName="Zargham"
21-
familyName="Ahmad"
22-
url="https://github.com/zargham-ahmad"
23-
identifier="0000-0000-0000-0000"/>
24-
<person
25-
givenName="Kristina"
26-
familyName="Gomoryova"
27-
url="https://github.com/KristinaGomoryova"
28-
identifier="0000-0003-4407-3917" />
29-
<person
30-
givenName="Helge"
31-
familyName="Hecht"
32-
url="https://github.com/hechth"
33-
identifier="0000-0001-6744-996X" />
34-
<organization
35-
url="https://www.recetox.muni.cz/"
36-
email="GalaxyToolsDevelopmentandDeployment@space.muni.cz"
37-
name="RECETOX MUNI" />
38-
</creator>
18+
<expand macro="creator"/>
3919
<command detect_errors="aggressive"><![CDATA[
4020
#if $input_file.ext == "tabular"
4121
#set $input_file_new = 'input.tsv'
@@ -46,19 +26,20 @@
4626
python3 -m rcx_tk --method ${method} ${input_file_new} 'output.tsv'
4727
]]></command>
4828
<inputs>
49-
<param name="input_file" type="data" format="csv,tabular,tsv,xls,xlsx,txt" label="Input data file" help="Upload your sample metadata (sequence) or alkane file."/>
50-
<param name="method" type="select" label="Processing method" help="Select whether to process a metadata file or an alkane file. This determines the column arrangement and validation steps.">
51-
<option value="metadata" selected="true">Metadata file</option>
29+
<param name="input_file" type="data" format="csv,tabular,tsv,xls,xlsx,txt" label="Input data file" help="Upload your sample sequence or alkane file."/>
30+
<param name="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.">
31+
<option value="sequence" selected="true">Sequence file</option>
5232
<option value="alkanes">Alkane file</option>
33+
<option value="msdial">MS-DIAL file</option>
5334
</param>
5435
</inputs>
5536
<outputs>
56-
<data name="output_file" format="tabular" from_work_dir = "output.tsv" label="Processed ${method} (dataset ${input_file.id})"/>
37+
<data name="output_file" format="tabular" from_work_dir = "output.tsv" label="Processed as ${method} on dataset ${input_file.id}"/>
5738
</outputs>
5839
<tests>
5940
<test>
6041
<param name="input_file" value="input_metadata.tabular"/>
61-
<param name="method" value="metadata"/>
42+
<param name="method" value="sequence"/>
6243
<output name="output_file" file="output_metadata.tsv"/>
6344
</test>
6445
<test>
@@ -72,12 +53,12 @@
7253
.. _rcx_tk:
7354
7455
======================================
75-
rcx-tk: Metadata/Alkane File Processor
56+
rcx-tk: Sequence/Alkane File Processor
7657
======================================
7758
7859
**Tool Description**
7960
80-
rcx-tk is a tool for processing sample metadata (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.
61+
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.
8162
8263
How it works
8364
------------
@@ -90,10 +71,10 @@ Inputs
9071
------
9172
9273
1. **Input data file**
93-
Upload your sample metadata (sequence) or alkane file. Supported formats: CSV, TSV, tabular, XLS, XLSX, or TXT.
74+
Upload your sample sequence or alkane file. Supported formats: CSV, TSV, tabular, XLS, XLSX, or TXT.
9475
9576
2. **Processing method**
96-
Select whether to process a metadata file or an alkane file. This determines the column arrangement and validation steps.
77+
Select whether to process a sequence file or an alkane file. This determines the column arrangement and validation steps.
9778
9879
Outputs
9980
-------
@@ -104,7 +85,7 @@ Outputs
10485
Example
10586
-------
10687
107-
Suppose you have a metadata file in CSV or tabular format. Select "Metadata file" as the processing method and upload your file. The tool will output a processed TSV file with standardized columns and additional identifiers.
88+
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.
10889
10990
Notes
11091
-----

0 commit comments

Comments
 (0)