Skip to content

New tool: FastSpar a tool for correlation estimation for compositional data.#7059

Merged
bgruening merged 8 commits intogalaxyproject:mainfrom
neo417:fastspar
Jun 19, 2025
Merged

New tool: FastSpar a tool for correlation estimation for compositional data.#7059
bgruening merged 8 commits intogalaxyproject:mainfrom
neo417:fastspar

Conversation

@neo417
Copy link
Copy Markdown
Contributor

@neo417 neo417 commented Jun 16, 2025

FOR CONTRIBUTOR:

  • I have read the CONTRIBUTING.md document and this tool is appropriate for the tools-iuc repo.
  • License permits unrestricted use (educational + commercial)
  • This PR adds a new tool or tool collection
  • This PR updates an existing tool or tool collection
  • This PR does something else (explain below)

I made a pull request for this tool at bgruening/galaxytools#1637 and @bgruening suggested that I also submit the tool here.

FastSpar is a C++ implementation of the SparCC algorithm for estimating correlations from compositional data.
FastSpar GitHub: https://github.com/scwatts/fastspar

The tool wrapper is split into three files:
- fastspar: Only perform the correlation and covariance matrix estimation.
- fastspar_pvalues: Estimate pvalues for the correlation table. Both steps require some identical parameters,
  so this tool can also generate correlation and covariance tables. This saves the user from having to copy
  some parameter values, by only using this tool.
- fastspar_reduce: Filter the combined correlations and p-values to generate sparse matrices.

The test files are copied or generated from the FastSpar / SparCC repos.
@@ -0,0 +1,106 @@
<tool id="fastspar" name="FastSpar" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="24.2">
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should choose a slightly older profile.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping ... please also put the profile version into a macro

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the profile to 23.0.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make this a suite. See here

auto_tool_repositories:

neo417 added 4 commits June 17, 2025 14:41
…pvalues

This removes the help text "Must match the value used in the original FastSpar run.",
but this warning is also visible in other places in the tool.
Copy link
Copy Markdown
Member

@bgruening bgruening left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice.

--correlation '$correlation'
--covariance '$covariance'
--threads \${GALAXY_SLOTS:-1}
--yes
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you please add a comment ## what this param is doing?

Copy link
Copy Markdown
Contributor Author

@neo417 neo417 Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This parameter is necessary to skip a continue prompt when an OTU has only one permutation (all samples have identical counts).
The wrapper should probably pass the warning message to the user (beyond the error hidden in the job information panel), but I'm not sure if the problem is severe enough to fail the tool execution.

@@ -0,0 +1,106 @@
<tool id="fastspar" name="FastSpar" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="24.2">
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping ... please also put the profile version into a macro

Copy link
Copy Markdown
Member

@bgruening bgruening left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last nitpick from my side as suggestions :)

Thanks a lot @neo417

Co-authored-by: Björn Grüning <bjoern@gruenings.eu>
@bgruening bgruening merged commit 0e305d2 into galaxyproject:main Jun 19, 2025
13 checks passed
@bgruening
Copy link
Copy Markdown
Member

Thanks!

neo417 added a commit to neo417/usegalaxy-eu-tools that referenced this pull request Jul 20, 2025
bgruening pushed a commit to usegalaxy-eu/usegalaxy-eu-tools that referenced this pull request Jul 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants