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

MaAslin2-Tutorial #5173

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
611817f
MaAslin2-Tutorial
renu-pal Jul 16, 2024
ebbd4c9
Update topics/microbiome/tutorials/multivariable-association/tutorial.md
renu-pal Jul 30, 2024
fe85d9a
formatting
shiltemann Aug 12, 2024
d04399c
indent comment box to keep numbering in list correct
shiltemann Aug 12, 2024
f2acff0
rewrite zenodo links
shiltemann Aug 12, 2024
c761680
added tags and a test
renu-pal Aug 22, 2024
1ed7bd7
origin of input data, studies involving maaslin2 and summary of methods
renu-pal Aug 25, 2024
8b7a006
comparing maaslin2 with other tools in galaxy
renu-pal Sep 24, 2024
7b184cd
a bunch of edits
bgruening Sep 28, 2024
415272c
Update tutorial.md
bgruening Sep 28, 2024
546b191
Update topics/microbiome/tutorials/multivariable-association/data-lib…
renu-pal Sep 29, 2024
12b3f04
Update topics/microbiome/tutorials/multivariable-association/data-lib…
renu-pal Sep 29, 2024
5bd7914
remaining updates and lint issue
renu-pal Oct 1, 2024
fd99f28
citations, types of table and few corrections
renu-pal Oct 7, 2024
76dbe06
Update urldate to note
renu-pal Oct 8, 2024
ebbdefd
Update
renu-pal Oct 13, 2024
d729aa9
lint issue
renu-pal Oct 14, 2024
c6eae2a
minor lint issue
renu-pal Oct 16, 2024
63a44c4
change in zenodo path
renu-pal Oct 16, 2024
b10e57a
Delete topics/microbiome/tutorials/multivariable-association/workflow…
renu-pal Oct 16, 2024
74a3f39
Update and rename Workflow-constructed-from-history-'Determining-mult…
renu-pal Oct 16, 2024
0e828c1
Delete topics/microbiome/tutorials/multivariable-association/workflow…
renu-pal Oct 16, 2024
30d373a
Update topics/microbiome/tutorials/multivariable-association/tutorial.md
renu-pal Oct 17, 2024
0fa5562
Update topics/microbiome/tutorials/multivariable-association/tutorial.md
renu-pal Oct 17, 2024
76283dc
Update topics/microbiome/tutorials/multivariable-association/tutorial.md
renu-pal Oct 17, 2024
22fc038
Update topics/microbiome/tutorials/multivariable-association/tutorial.md
renu-pal Oct 17, 2024
bcc9c78
Update topics/microbiome/tutorials/multivariable-association/tutorial.md
renu-pal Oct 17, 2024
65c2a15
models,ampvis,subsection updates
renu-pal Oct 17, 2024
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
6 changes: 5 additions & 1 deletion CONTRIBUTORS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1858,7 +1858,11 @@ r1corre:
twitter: r1corre
orcid: 0000-0001-6354-2278
joined: 2019-04


renu-pal:
name: Renu Pal
joined: 2024-07

rikeshi:
name: Erik Schill
joined: 2021-05
Expand Down
Binary file added topics/microbiome/images/heatmap_maaslin2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
destination:
type: library
name: GTN - Material
description: Galaxy Training Network Material
synopsis: Galaxy Training Network Material. See https://training.galaxyproject.org
items:
- name: The new topic
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- name: The new topic
- name: The new topic

?

description: Summary
items:
- name: Determining multivariable association between various meta’omic features
using MaAslin2l
items:
- name: 'DOI: 10.5281/zenodo.12614561'
description: latest
items:
- url: https://zenodo.org/api/records/12614561/files/HMP2_metadata.tsv/content
Copy link
Collaborator

Choose a reason for hiding this comment

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

https://zenodo.org/records/12614561/files/HMP2_metadata.tsv should also work

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- url: https://zenodo.org/api/records/12614561/files/HMP2_metadata.tsv/content
- url: https://zenodo.org/api/records/12614561/files/HMP2_metadata.tsv

Copy link
Collaborator

Choose a reason for hiding this comment

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

why is it resolved, It's still not correct ... ?

Copy link
Author

Choose a reason for hiding this comment

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

I thought miss Shilteman made the last update about this exactly , I did not notice it was data-library.yaml file you were mentioning. I am extremely sorry for that. I will make the necessary changes.

Copy link
Author

Choose a reason for hiding this comment

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

Here, made the change
63a44c4

src: url
ext: auto
renu-pal marked this conversation as resolved.
Show resolved Hide resolved
info: https://zenodo.org/records/12614561
- url: https://zenodo.org/api/records/12614561/files/HMP2_taxonomy.tsv/content
src: url
ext: auto
renu-pal marked this conversation as resolved.
Show resolved Hide resolved
info: https://zenodo.org/records/12614561
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
layout: faq-page
---
42 changes: 42 additions & 0 deletions topics/microbiome/tutorials/multivariable-association/tutorial.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@

# This is the bibliography file for your tutorial.
#
# To add bibliography (bibtex) entries here, follow these steps:
# 1) Find the DOI for the article you want to cite
# 2) Go to https://doi2bib.org and fill in the DOI
# 3) Copy the resulting bibtex entry into this file
#
# To cite the example below, in your tutorial.md file
# use {% cite Batut2018 %}
#
# If you want to cite an online resourse (website etc)
# you can use the 'online' format (see below)
#
# You can remove the examples below

@article{Batut2018,
doi = {10.1016/j.cels.2018.05.012},
url = {https://doi.org/10.1016/j.cels.2018.05.012},
year = {2018},
month = jun,
publisher = {Elsevier {BV}},
volume = {6},
number = {6},
pages = {752--758.e1},
author = {B{\'{e}}r{\'{e}}nice Batut and Saskia Hiltemann and Andrea Bagnacani and Dannon Baker and Vivek Bhardwaj and
Clemens Blank and Anthony Bretaudeau and Loraine Brillet-Gu{\'{e}}guen and Martin {\v{C}}ech and John Chilton
and Dave Clements and Olivia Doppelt-Azeroual and Anika Erxleben and Mallory Ann Freeberg and Simon Gladman and
Youri Hoogstrate and Hans-Rudolf Hotz and Torsten Houwaart and Pratik Jagtap and Delphine Larivi{\`{e}}re and
Gildas Le Corguill{\'{e}} and Thomas Manke and Fabien Mareuil and Fidel Ram{\'{i}}rez and Devon Ryan and
Florian Christoph Sigloch and Nicola Soranzo and Joachim Wolff and Pavankumar Videm and Markus Wolfien and
Aisanjiang Wubuli and Dilmurat Yusuf and James Taylor and Rolf Backofen and Anton Nekrutenko and Bj\"{o}rn Gr\"{u}ning},
title = {Community-Driven Data Analysis Training for Biology},
journal = {Cell Systems}
}

@online{gtn-website,
author = {GTN community},
title = {GTN Training Materials: Collection of tutorials developed and maintained by the worldwide Galaxy community},
url = {https://training.galaxyproject.org},
urldate = {2021-03-24}
Copy link
Member

@shiltemann shiltemann Oct 7, 2024

Choose a reason for hiding this comment

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

our bibtex parser is failing to parse urldate key. I think we should support this in the future, but perhaps for now you can set the date in a note so that the tests don't fail, e.g.:

note = "[Online; accessed Fri Nov 05 2021]"

Copy link
Author

Choose a reason for hiding this comment

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

Thanks ! Will make the necessary changes :)

Copy link
Author

Choose a reason for hiding this comment

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

}
347 changes: 347 additions & 0 deletions topics/microbiome/tutorials/multivariable-association/tutorial.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
- doc: "Test outline for Workflow-constructed-from-history-'Determining-multivariable-association-between-various-meta\u2019\
omic-features-using-MaAslin2"
job:
HMP2_taxonomy.tsv:
location: https://zenodo.org/records/12614561/files/HMP2_taxonomy.tsv
class: File
filetype: tabular
HMP2_metadata.tsv:
location: https://zenodo.org/records/12614561/files/HMP2_metadata.tsv
class: File
filetype: tabular
outputs:
significant_results:
asserts:
has_n_columns:
n: 9

Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
{
"a_galaxy_workflow": "true",
"annotation": "",
"comments": [],
"format-version": "0.1",
"name": "Workflow constructed from history 'Determining multivariable association between various meta\u2019omic features using MaAslin2",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"name": "Workflow constructed from history 'Determining multivariable association between various meta\u2019omic features using MaAslin2",
"name": "Determining multivariable association between various meta-omic features using MaAslin2",

This way?

Copy link
Author

Choose a reason for hiding this comment

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

I kept the omitted part just to differentiate a between the title of workflow file and tutorial file. If it doesn't cause any issue then I believe we should not change it. What are your thoughts on this ? @bgruening

Copy link
Member

Choose a reason for hiding this comment

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

I don't see any reason why a workflow should be named 'construceted from history'

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you please remove the two workflows, starting with Workflow constructed from history ...` and only keep the main one with the correct title ?

Copy link
Author

Choose a reason for hiding this comment

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

"steps": {
"0": {
"annotation": "",
"content_id": null,
"errors": null,
"id": 0,
"input_connections": {},
"inputs": [
{
"description": "",
"name": "HMP2_taxonomy.tsv"
}
],
"label": "HMP2_taxonomy.tsv",
"name": "Input dataset",
"outputs": [],
"position": {
"left": 10,
"top": 10
},
"tool_id": null,
"tool_state": "{\"optional\": false, \"tag\": null}",
"tool_version": null,
"type": "data_input",
"uuid": "2f31b06f-1730-427d-b729-363d0e77a8cd",
"when": null,
"workflow_outputs": []
},
"1": {
"annotation": "",
"content_id": null,
"errors": null,
"id": 1,
"input_connections": {},
"inputs": [
{
"description": "",
"name": "HMP2_metadata.tsv"
}
],
"label": "HMP2_metadata.tsv",
"name": "Input dataset",
"outputs": [],
"position": {
"left": 10,
"top": 130
},
"tool_id": null,
"tool_state": "{\"optional\": false, \"tag\": null}",
"tool_version": null,
"type": "data_input",
"uuid": "8f312ad3-13b5-4664-902f-93eb071a14ef",
"when": null,
"workflow_outputs": []
},
"2": {
"annotation": "",
"content_id": "toolshed.g2.bx.psu.edu/repos/iuc/maaslin2/maaslin2/1.16.0+galaxy0",
"errors": null,
"id": 2,
"input_connections": {
"input_data": {
"id": 0,
"output_name": "output"
},
"input_metadata": {
"id": 1,
"output_name": "output"
}
},
"inputs": [],
"label": null,
"name": "MaAsLin 2",
"outputs": [
{
"name": "figures_pdfs",
"type": "input"
},
{
"name": "archive_output",
"type": "zip"
},
{
"name": "all_results",
"type": "tabular"
},
{
"name": "significant_results",
"type": "tabular"
},
{
"name": "residuals",
"type": "rdata"
},
{
"name": "headmap",
"type": "pdf"
}
],
"position": {
"left": 230,
"top": 10
},
"post_job_actions": {},
"tool_id": "toolshed.g2.bx.psu.edu/repos/iuc/maaslin2/maaslin2/1.16.0+galaxy0",
"tool_shed_repository": {
"changeset_revision": "43ccbef89f1d",
"name": "maaslin2",
"owner": "iuc",
"tool_shed": "toolshed.g2.bx.psu.edu"
},
"tool_state": "{\"__input_ext\": \"input\", \"additional_options\": {\"min_abundance\": \"0.0\", \"min_prevalence\": \"0.1\", \"max_significance\": \"0.25\", \"normalization\": \"TSS\", \"transform\": \"LOG\", \"analysis_method\": \"LM\", \"correction\": null, \"standardize\": true}, \"chromInfo\": \"/opt/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"fixed_effects\": [\"3\", \"4\"], \"input_data\": null, \"input_metadata\": null, \"output\": {\"plot_heatmap\": true, \"heatmap_first_n\": \"50\", \"plot_scatter\": true, \"residuals_output\": true}, \"random_effects\": [\"5\"], \"reference\": \"diagnosis,CD\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
"tool_version": "1.16.0+galaxy0",
"type": "tool",
"uuid": "d213582b-bf65-4705-a09b-73466f5007c1",
"when": null,
"workflow_outputs": []
}
},
"tags": [],
"uuid": "8da7151e-1680-44c8-b9c2-6ce5e127338a",
"version": 1
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
layout: workflow-list
---
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"a_galaxy_workflow": "true", "annotation": "", "comments": [], "format-version": "0.1", "name": "Workflow constructed from history 'Determining multivariable association between various meta\u2019omic features using MaAslin2", "steps": {"0": {"annotation": "", "content_id": null, "errors": null, "id": 0, "input_connections": {}, "inputs": [{"description": "", "name": "HMP2_taxonomy.tsv"}], "label": "HMP2_taxonomy.tsv", "name": "Input dataset", "outputs": [], "position": {"left": 10, "top": 10}, "tool_id": null, "tool_state": "{\"optional\": false, \"tag\": null}", "tool_version": null, "type": "data_input", "uuid": "2f31b06f-1730-427d-b729-363d0e77a8cd", "when": null, "workflow_outputs": []}, "1": {"annotation": "", "content_id": null, "errors": null, "id": 1, "input_connections": {}, "inputs": [{"description": "", "name": "HMP2_metadata.tsv"}], "label": "HMP2_metadata.tsv", "name": "Input dataset", "outputs": [], "position": {"left": 10, "top": 130}, "tool_id": null, "tool_state": "{\"optional\": false, \"tag\": null}", "tool_version": null, "type": "data_input", "uuid": "8f312ad3-13b5-4664-902f-93eb071a14ef", "when": null, "workflow_outputs": []}, "2": {"annotation": "", "content_id": "toolshed.g2.bx.psu.edu/repos/iuc/maaslin2/maaslin2/1.16.0+galaxy0", "errors": null, "id": 2, "input_connections": {"input_data": {"id": 0, "output_name": "output"}, "input_metadata": {"id": 1, "output_name": "output"}}, "inputs": [], "label": null, "name": "MaAsLin 2", "outputs": [{"name": "figures_pdfs", "type": "input"}, {"name": "archive_output", "type": "zip"}, {"name": "all_results", "type": "tabular"}, {"name": "significant_results", "type": "tabular"}, {"name": "residuals", "type": "rdata"}, {"name": "headmap", "type": "pdf"}], "position": {"left": 230, "top": 10}, "post_job_actions": {}, "tool_id": "toolshed.g2.bx.psu.edu/repos/iuc/maaslin2/maaslin2/1.16.0+galaxy0", "tool_shed_repository": {"changeset_revision": "43ccbef89f1d", "name": "maaslin2", "owner": "iuc", "tool_shed": "toolshed.g2.bx.psu.edu"}, "tool_state": "{\"__input_ext\": \"input\", \"additional_options\": {\"min_abundance\": \"0.0\", \"min_prevalence\": \"0.1\", \"max_significance\": \"0.25\", \"normalization\": \"TSS\", \"transform\": \"LOG\", \"analysis_method\": \"LM\", \"correction\": null, \"standardize\": true}, \"chromInfo\": \"/opt/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"fixed_effects\": [\"3\", \"4\"], \"input_data\": null, \"input_metadata\": null, \"output\": {\"plot_heatmap\": true, \"heatmap_first_n\": \"50\", \"plot_scatter\": true, \"residuals_output\": true}, \"random_effects\": [\"5\"], \"reference\": \"diagnosis,CD\", \"__page__\": null, \"__rerun_remap_job_id__\": null}", "tool_version": "1.16.0+galaxy0", "type": "tool", "uuid": "d213582b-bf65-4705-a09b-73466f5007c1", "when": null, "workflow_outputs": []}}, "tags": [], "uuid": "8da7151e-1680-44c8-b9c2-6ce5e127338a", "version": 1}
Loading
Loading