Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xcms: use element identifier #238

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
ad1a1dd
xcms: use element identifier
bernt-matthias May 12, 2023
5a55d39
xcms datatypes are now in galaxy
bernt-matthias May 12, 2023
e459299
add profile
bernt-matthias May 12, 2023
0b0e8db
reset version token add suffix token
bernt-matthias May 12, 2023
91d6256
fix output
bernt-matthias May 12, 2023
ecfbffc
fix R linter errors
bernt-matthias May 12, 2023
4d140ce
remove datatypes
bernt-matthias May 16, 2023
1a5dc17
more R linter fixes
bernt-matthias May 16, 2023
e55b784
msnbase remove outdated link and docs
bernt-matthias May 16, 2023
e66acb0
fix linter warnings
bernt-matthias May 16, 2023
ab45737
update workflow
bernt-matthias May 22, 2023
5bf4676
restructure: export_samplemetadata
bernt-matthias May 24, 2023
571d61e
restructure: fillpeaks
bernt-matthias May 24, 2023
4588b3e
restructure: group
bernt-matthias May 24, 2023
4011a9b
restructure: merge
bernt-matthias May 24, 2023
ef7de53
restructure: refine & plot chromatogram
bernt-matthias May 25, 2023
0988c6a
restructure: retcor
bernt-matthias May 25, 2023
7b623b2
restructure: set
bernt-matthias May 25, 2023
9f96d46
relocate: summary
bernt-matthias May 25, 2023
cb366a2
relocate: msnbase_readmsdata
bernt-matthias May 25, 2023
3b1aba2
relocate: move 'unused' scripts and test data
bernt-matthias May 25, 2023
55f9464
more r linting issue
bernt-matthias May 25, 2023
49dab2b
xcms: fix tool linting warnings/errors
bernt-matthias May 25, 2023
8e01e3c
fix indentations
bernt-matthias Sep 6, 2023
e99aa02
Fix repo owner
bernt-matthias Sep 5, 2023
112dc0e
more indentation fixes
bernt-matthias Sep 6, 2023
739f6dd
more indentation fixes
bernt-matthias Sep 6, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/workflows/pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
echo 'event.after: ${{ github.event.after }}'
- name: Determine latest commit in the Galaxy repo
id: get-galaxy-sha
run: echo "::set-output name=galaxy-head-sha::$(git ls-remote https://github.com/${{ env.GALAXY_FORK }}/galaxy refs/heads/${{ env.GALAXY_BRANCH }} | cut -f1)"
run: echo "galaxy-head-sha=$(git ls-remote https://github.com/${{ env.GALAXY_FORK }}/galaxy refs/heads/${{ env.GALAXY_BRANCH }} | cut -f1)" >> $GITHUB_OUTPUT
- uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
Expand Down Expand Up @@ -115,6 +115,7 @@ jobs:
id: lint
with:
mode: lint
fail-level: warn
repository-list: ${{ needs.setup.outputs.repository-list }}
tool-list: ${{ needs.setup.outputs.tool-list }}
- uses: actions/upload-artifact@v3
Expand Down Expand Up @@ -311,7 +312,7 @@ jobs:
combine_outputs:
name: Combine chunked test results
needs: [setup, test]
if: ${{ needs.setup.outputs.repository-list != '' }}
if: ${{ always() && needs.setup.outputs.repository-list != '' }}
runs-on: ubuntu-latest
strategy:
matrix:
Expand Down Expand Up @@ -344,6 +345,12 @@ jobs:
id: check
with:
mode: check
- name: Check if all test chunks succeeded
run: |
NFILES=$(ls artifacts/ | grep "Tool test output" | wc -l)
if [[ "${{ needs.setup.outputs.chunk-count }}" != "$NFILES" ]]; then
exit 1
fi

# deploy the tools to the toolsheds (first TTS for testing)
deploy:
Expand Down
9 changes: 0 additions & 9 deletions tools/msnbase_readmsdata/.shed.yml

This file was deleted.

21 changes: 0 additions & 21 deletions tools/msnbase_readmsdata/README.rst

This file was deleted.

1 change: 0 additions & 1 deletion tools/msnbase_readmsdata/lib.r

This file was deleted.

1 change: 0 additions & 1 deletion tools/msnbase_readmsdata/macros.xml

This file was deleted.

1 change: 0 additions & 1 deletion tools/msnbase_readmsdata/macros_msnbase.xml

This file was deleted.

1 change: 0 additions & 1 deletion tools/msnbase_readmsdata/repository_dependencies.xml

This file was deleted.

1 change: 0 additions & 1 deletion tools/msnbase_readmsdata/test-data/faahKO_reduce.zip

This file was deleted.

1 change: 0 additions & 1 deletion tools/msnbase_readmsdata/test-data/ko15.CDF

This file was deleted.

124 changes: 124 additions & 0 deletions tools/xcms/.shed.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
definitions:
include: &default-includes
- test-data
- static
- lib.r
- macros_xcms.xml
- macros.xml

name: xcms
owner: workflow4metabolomics
remote_repository_url: https://github.com/workflow4metabolomics/tools-metabolomics/
homepage_url: https://github.com/sneumann/xcms
categories:
- Metabolomics

repositories:
xcms_export_samplemetadata:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Get a sample metadata file'
long_description: |
Generates a skeleton of sampleMetadata
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, xcms_export_samplemetadata.xml, xcms_export_samplemetadata.r]
xcms_fillpeaks:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Integrate areas of missing peaks'
long_description: |
For each sample, identify peak groups where that sample is not represented.
For each of those peak groups, integrate the signal in the region of that peak group and create a new peak.
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, abims_xcms_fillPeaks.xml, xcms_fillpeaks.r]
xcms_group:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Group peaks from different samples together'
long_description: |
Group peaks together across samples using overlapping m/z bins and
calculation of smoothed peak distributions in chromatographic time.
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, abims_xcms_group.xml, xcms_group.r]
xcms_merge:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Merge individual xcmsSet outputs'
long_description: |
Filtration and Peak Identification using xcmsSet function from xcms R
package to preprocess LC/MS data for relative quantification and
statistical analysis
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, xcms_merge.xml, xcms_merge.r]
xcms_plot_chromatogram:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Plot base peak intensity chromatogram (BPI) and total ion chromatogram (TIC)'
long_description: |
Plot base peak intensity chromatogram (BPI) and total ion chromatogram (TIC)
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, xcms_plot_chromatogram.xml, xcms_plot_chromatogram.r]
xcms_refine:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Refine choice of peaks'
long_description: |
Remove or merge chromatographic peaks based on specific criteria.
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: workflow4metabolomics
include:
[*default-includes, abims_xcms_refine.xml, xcms_refine.r]
xcms_retcor:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Correct retention time from different samples'
long_description: |
Retention Time Correction using retcor function from xcms R package
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, abims_xcms_refine.xml, xcms_refine.r]
xcms_xcmsset:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - peaks calling in NetCDF/mzXML files'
long_description: |
Filtration and Peak Identification using xcmsSet function from xcms R
package to preprocess LC/MS data for relative quantification and
statistical analysis
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, abims_xcms_xcmsSet.xml, xcms_xcmsSet.r]
xcms_summary:
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - HTML Summary for XCMS and CAMERA analysis'
long_description: |
This tool create a HTML summary of XCMS and CAMERA analysis
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, abims_xcms_summary.xml, xcms_summary.r]
msnbase_readmsdata:
description: '[Metabolomics][W4M][LC-MS] MSnbase R Package - Preprocessing - Imports Mass-Spectrometry Data Files'
long_description: |
Reads XML-based mass-spectrometry data files. Can be chained with the W4M
xcms.findChromPeaks tool
Part of the W4M project: http://workflow4metabolomics.org
XCMS: http://www.bioconductor.org/packages/release/bioc/html/xcms.html
owner: lecorguille
include:
[*default-includes, msnbase_readmsdata.xml, msnbase_readmsdata.r, macros_msnbase.xml]

suite:
name: suite_xcms
owner: lecorguille
homepage_url: http://workflow4metabolomics.org
description: '[Metabolomics][W4M][LC-MS] XCMS R Package - Preprocessing - Framework for processing data for high-throughput, untargeted analyte profiling'
long_description: |
Part of the W4M project: http://workflow4metabolomics.org XCMS:
http://www.bioconductor.org/packages/release/bioc/html/xcms.html
XCMS: processing mass spectrometry data for metabolite profiling
using nonlinear peak alignment, matching, and identification
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<tool id="abims_xcms_fillPeaks" name="xcms fillChromPeaks (fillPeaks)" version="@TOOL_VERSION@+galaxy0">
<tool id="abims_xcms_fillPeaks" name="xcms fillChromPeaks (fillPeaks)" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">

<description>Integrate areas of missing peaks</description>

Expand Down Expand Up @@ -128,7 +128,7 @@
<output name="variableMetadata" file="faahKO.xset.group2.retcor2.group2.fillPeaks2.variableMetadata.tsv" />
<output name="dataMatrix" file="faahKO.xset.group2.retcor2.group2.fillPeaks2.dataMatrix.tsv" />
</test>-->
<test>
<test expect_num_outputs="3">
<param name="image" value="faahKO-single-class.xset.merged.group.retcor.group.RData" ftype="rdata"/>
<section name="peaklist">
<param name="peaklistBool" value="true" />
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<tool id="abims_xcms_group" name="xcms groupChromPeaks (group)" version="@TOOL_VERSION@+galaxy0">
<tool id="abims_xcms_group" name="xcms groupChromPeaks (group)" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">

<description>Perform the correspondence, the grouping of chromatographic peaks within and between samples.</description>

Expand Down Expand Up @@ -203,7 +203,7 @@
</test>
-->
<!-- from retcor -->
<test>
<test expect_num_outputs="4">
<param name="image" value="faahKO-single-class.xset.merged.group.retcor.RData" ftype="rdata"/>
<conditional name="methods">
<param name="method" value="PeakDensity"/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<tool id="abims_xcms_refine" name="xcms refineChromPeaks (refine)" version="3.12.0+galaxy0">
<tool id="abims_xcms_refine" name="xcms refineChromPeaks (refine)" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">

<description>Remove or merge chromatographic peaks based on specific criteria.</description>

Expand Down Expand Up @@ -77,7 +77,7 @@
test 1 - MergeNeighboringPeaks method
-->
<test>
<param name="image" value="faahKO-single.xset.merged.RData" ftype="rdata"/>
<param name="image" value="faahKO-single-class.xset.merged.group.RData" ftype="rdata"/>
<conditional name="methods">
<param name="method" value="MergeNeighboringPeaks"/>
<param name="expandRt" value="2" />
Expand All @@ -104,7 +104,7 @@
test 2 - FilterIntensity method
-->
<test>
<param name="image" value="faahKO-single.xset.merged.RData" ftype="rdata"/>
<param name="image" value="faahKO-single-class.xset.merged.group.RData" ftype="rdata"/>
<conditional name="methods">
<param name="method" value="FilterIntensity"/>
<param name="threshold" value="1e5" />
Expand All @@ -126,7 +126,7 @@
test 3 - CleanPeaks method
-->
<test>
<param name="image" value="faahKO-single.xset.merged.RData" ftype="rdata"/>
<param name="image" value="faahKO-single-class.xset.merged.group.RData" ftype="rdata"/>
<conditional name="methods">
<param name="method" value="CleanPeaks"/>
<param name="maxPeakwidth" value="8" />
Expand Down Expand Up @@ -244,7 +244,7 @@ xset.RData: rdata.xcms.findchrompeaks format
Changelog/News
--------------

.. _News: https://bioconductor.org/packages/release/bioc/news/xcms/NEWS
.. _news: https://bioconductor.org/packages/release/bioc/news/xcms/NEWS


**Version 3.6.1.0 - 08/02/2021**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<tool id="abims_xcms_retcor" name="xcms adjustRtime (retcor)" version="@TOOL_VERSION@+galaxy0">
<tool id="abims_xcms_retcor" name="xcms adjustRtime (retcor)" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">

<description>Retention Time Correction</description>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<tool id="abims_xcms_summary" name="xcms process history" version="@TOOL_VERSION@+galaxy0">
<tool id="abims_xcms_summary" name="xcms process history" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">

<description>Create a summary of XCMS analysis</description>

Expand Down Expand Up @@ -41,7 +41,7 @@
</test>-->
<test>
<param name="image" value="faahKO-single.xset.merged.group.retcor.group.fillpeaks.RData" ftype="rdata"/>
<output name="htmlOutput" file="faahKO-single.xset.merged.group.retcor.group.fillpeaks.summary.html" />
<output name="htmlOutput" file="faahKO-single.xset.merged.group.retcor.group.fillpeaks.summary.html" lines_diff="2"/>
</test>
</tests>

Expand Down Expand Up @@ -82,6 +82,8 @@ CAMERA.annotate ``*``.annotate.*.RData rdata.camera.``*``

.. image:: xcms_summary_workflow.png

@HELP_XCMS_MANUAL@

---------------------------------------------------

Changelog/News
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<tool id="abims_xcms_xcmsSet" name="xcms findChromPeaks (xcmsSet)" version="@TOOL_VERSION@+galaxy0">
<tool id="abims_xcms_xcmsSet" name="xcms findChromPeaks (xcmsSet)" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
<description>Chromatographic peak detection</description>

<macros>
Expand Down Expand Up @@ -187,11 +187,8 @@
<outputs>
<data name="xsetRData" format="rdata.xcms.findchrompeaks" label="${image.name.rsplit('.',1)[0]}.xset.RData" from_work_dir="xcmsSet.RData" />
<data name="log" format="txt" label="${image.name.rsplit('.',1)[0]}.xset.log.txt" from_work_dir="log.txt" />
<data name="peaklist_out1" format="tabular" label="${image.name[:-6]}.chromPeak_table.tsv" from_work_dir="chromPeak_table.tsv" >
<filter>methods['method'] == 'CentWave' and (methods['CentWaveAdv']['peaklist'])</filter>
</data>
<data name="peaklist_out2" format="tabular" label="${image.name[:-6]}.chromPeak_table.tsv" from_work_dir="chromPeak_table.tsv" >
<filter>methods['method'] == 'MatchedFilter' and (methods['MatchedFilterAdv']['peaklist'])</filter>
<data name="peaklist_out" format="tabular" label="${image.name[:-6]}.chromPeak_table.tsv" from_work_dir="chromPeak_table.tsv" >
<filter>methods['method'] in ['CentWave', 'MatchedFilter'] and (methods['CentWaveAdv']['peaklist'])</filter>
</data>
</outputs>

Expand Down Expand Up @@ -227,7 +224,7 @@
<has_text text="Sample classes: KO, WT" />
</assert_stdout>
</test>-->
<test>
<test expect_num_outputs="2">
<param name="image" value="ko15-raw.RData" ftype="rdata" />
<conditional name="methods">
<param name="method" value="CentWave" />
Expand Down
Loading