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

Improve worklow names as shown in Galaxy #517

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mvdbeek
Copy link
Member

@mvdbeek mvdbeek commented Sep 6, 2024

@dannon is working on a static site listing our workflows, and we'd like to have better workflow names. I've made a first pass here, but I would love input from everyone.

@bgruening
Copy link
Member

@mvdbeek directly into the PR or separate ones?

@mvdbeek
Copy link
Member Author

mvdbeek commented Sep 7, 2024

Feel free to push to the PR or comment

Copy link
Contributor

@lldelisle lldelisle left a comment

Choose a reason for hiding this comment

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

Here are my suggestions.

@@ -554,7 +554,7 @@
},
"inputs": [],
"label": "Compute fragment length histogram",
"name": "Paired-end histogram",
"name": "paired end histogram",
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this change on purpose or a side effect?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's the tool name, shouldn't change it

@@ -11,7 +11,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.11",
"name": "ChIPseq_PE",
"name": "ChIPseq: Paired End",
Copy link
Contributor

Choose a reason for hiding this comment

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

ok

@@ -11,7 +11,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.11",
"name": "ChIPseq_SR",
"name": "ChIPseq: Single Read",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -82,7 +82,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "1.1",
"name": "Get Confident Peaks From ChIP_PE replicates",
"name": "Get Confident Peaks From Paired End ChIP replicates",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -82,7 +82,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "1.1",
"name": "Get Confident Peaks From ChIP_SR replicates",
"name": "Get Confident Peaks From Single Read ChIP replicates",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

Copy link
Contributor

@wm75 wm75 left a comment

Choose a reason for hiding this comment

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

Just to avoid redundant work: you are aware of https://training.galaxyproject.org/training-material/workflows/list.html and checked if that's reuseable in some way?

@@ -1,6 +1,6 @@
{
"a_galaxy_workflow": "true",
"annotation": "Importing demultiplexed data (single-end)",
"annotation": "Importing demultiplexed data (single read)",
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't it be single-end reads instead of single read everywhere?

Copy link
Member Author

Choose a reason for hiding this comment

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

@mvdbeek mvdbeek force-pushed the user_friendly_workflow_names branch from a4be211 to f7328f0 Compare September 9, 2024 14:21
@mvdbeek
Copy link
Member Author

mvdbeek commented Sep 9, 2024

Just to avoid redundant work: you are aware of https://training.galaxyproject.org/training-material/workflows/list.html and checked if that's reuseable in some way?

The workflow name change will also benefit this, but I think we want a component that we can embed in the BRC analytics site where we need additional functionality.

@mvdbeek
Copy link
Member Author

mvdbeek commented Sep 10, 2024

@Delphine-L could you also take a look at this ?

@@ -21,7 +21,7 @@
"format-version": "0.1",
"license": "CC-BY-4.0",
"release": "0.2.2",
"name": "Assembly-Hifi-HiC-phasing-VGP4",
"name": "Contiging Solo with HiC data VGP4",
Copy link
Contributor

@Delphine-L Delphine-L Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
"name": "Contiging Solo with HiC data VGP4",
"name": "Assembly with Hifi reads and Hi-C data VGP4",

@@ -16,7 +16,7 @@
"format-version": "0.1",
"license": "CC-BY-4.0",
"release": "0.2.1",
"name": "Assembly-Hifi-only-VGP3",
"name": "Contiging Solo VGP3",
Copy link
Contributor

@Delphine-L Delphine-L Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
"name": "Contiging Solo VGP3",
"name": "Assembly with Hifi reads VGP3",

@Delphine-L you can add suggestions by using this https://stackoverflow.com/questions/54239733/how-can-i-manually-add-suggestions-in-code-reviews-on-github

I changed your suggestion accordingly.

@@ -15,7 +15,7 @@
],
"format-version": "0.1",
"license": "CC-BY-4.0",
"name": "Mitogenome-Assembly-VGP0",
"name": "Mitogenome Assembly VGP0",
Copy link
Contributor

@Delphine-L Delphine-L Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
"name": "Mitogenome Assembly VGP0",
"name": "Mitogenome Assembly with Hifi data VGP0",

Copy link
Member

Choose a reason for hiding this comment

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

is it maybe time to remove the VGPx suffix from all names?

@@ -16,7 +16,7 @@
"format-version": "0.1",
"license": "CC-BY-4.0",
"release": "0.4",
"name": "Purge-duplicate-contigs-VGP6",
"name": "Purge duplicate contigs VGP6",
Copy link
Contributor

@Delphine-L Delphine-L Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
"name": "Purge duplicate contigs VGP6",
"name": "Purge duplicate contigs from two haplotypes VGP6"

@@ -16,7 +16,7 @@
"format-version": "0.1",
"license": "CC-BY-4.0",
"release": "0.7.1",
"name": "Purging-duplicates-one-haplotype-VGP6b ",
"name": "Purge Duplicate Contigs VGP6b",
Copy link
Contributor

@Delphine-L Delphine-L Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
"name": "Purge Duplicate Contigs VGP6b",
"name": "Purge duplicate contigs from one haplotypes VGP6b"

@@ -16,7 +16,7 @@
"format-version": "0.1",
"license": "CC-BY-4.0",
"release": "0.2.7",
"name": "Scaffolding-HiC-VGP8",
"name": "Scaffolding with HiC data VGP8",
Copy link
Contributor

@Delphine-L Delphine-L Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
"name": "Scaffolding with HiC data VGP8",
"name": "Scaffolding with Hi-C data VGP8",

@@ -15,7 +15,7 @@
"format-version": "0.1",
"license": "CC-BY-4.0",
"release": "0.1.4",
"name": "kmer-profiling-hifi-trio-VGP2",
"name": "K-mer profiling with HiFi trio data VGP2",
Copy link
Contributor

@Delphine-L Delphine-L Sep 10, 2024

Choose a reason for hiding this comment

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

Suggested change
"name": "K-mer profiling with HiFi trio data VGP2",
"name": "K-mer profiling for PacBio HiFi and Trio data VGP2",

@@ -11,7 +11,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.3",
"name": "cHi-C_fastqToCool_hicup_cooler",
"name": "Hi-C: fastq to balanced cool using HiCUP and Cooler",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"name": "Hi-C: fastq to balanced cool using HiCUP and Cooler",
"name": "capture Hi-C: fastq to balanced cool using HiCUP and Cooler",

@@ -11,7 +11,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.5",
"name": "baredSC_1d_logNorm",
"name": "baredSC 1D logNorm",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -11,7 +11,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.5",
"name": "baredSC_2d_logNorm",
"name": "baredSC 2D logNorm",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -31,7 +31,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.4",
"name": "scRNA-seq_preprocessing_10X_cellPlex",
"name": "Single-cell RNA-seq fastq to matrix for 10X cellPlex data",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -31,7 +31,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.4",
"name": "scRNA-seq_preprocessing_10X_v3_Bundle",
"name": "Single-cell RNA-seq fastq to bundled matrix for 10X V3 data",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -1,6 +1,6 @@
# Velocyto on 10X data

These workflows simply run velocyto. There are 2 workflows because one can be easily run after the 'fastq-to-matrix-10x' workflows (Velocyto-on10X-from-bundled). The other can be easily run from uploaded datasets (Velocyto-on10X-filtered-barcodes).
These workflows simply run velocyto. There are 2 workflows because one can be easily run after the 'fastq-to-matrix-10x' workflows (Velocyto for 10X bundled data). The other can be easily run from uploaded datasets (Velocyto for 10X filtered barcode data).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
These workflows simply run velocyto. There are 2 workflows because one can be easily run after the 'fastq-to-matrix-10x' workflows (Velocyto for 10X bundled data). The other can be easily run from uploaded datasets (Velocyto for 10X filtered barcode data).
These workflows simply run velocyto. There are 2 workflows because one can be easily run after the 'Single-cell RNA-seq fastq to bundled matrix for 10X ... data' workflows (Velocyto for 10X bundled data). The other can be easily run from uploaded datasets (Velocyto for 10X filtered barcode data).

@@ -12,7 +12,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.2",
"name": "Velocyto-on10X-filtered-barcodes",
"name": "Velocyto for 10X filtered barcode data",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -12,7 +12,7 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.2",
"name": "Velocyto-on10X-from-bundled",
"name": "Velocyto for 10X bundled data",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -12,17 +12,17 @@
"format-version": "0.1",
"license": "MIT",
"release": "0.8",
"name": "RNAseq_PE",
"name": "RNA-seq Paired End",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

@@ -11,7 +11,7 @@
],
"format-version": "0.1",
"license": "MIT",
"name": "RNAseq_SR",
"name": "RNA-seq Single Read",
Copy link
Contributor

Choose a reason for hiding this comment

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

OK

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.

5 participants