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

Creation of FAQ for using workflow variables to rename outputs #5267

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
51 changes: 51 additions & 0 deletions faqs/galaxy/workflows_variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Rename outputs in a workflow using workflow variables
area: workflows
box_type: tip
layout: faq
contributors: [delphine-l]
optional_parameters:
var_name: Name of the workflow Variable
examples:
Use a Species Name:
var_name: "Species Name"
---

Workflow text inputs can be used as parameters for tools but also in the workflow editor for renaming files.

{% if include.var_name %}
Copy link
Member

@shiltemann shiltemann Sep 13, 2024

Choose a reason for hiding this comment

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

instead of this big if/else case, you can also just do {{ include.var_name | default: "Species Name" }} to default to a value if no include variable provided

# Create a workflow variable

1. Open the workflow editor
2. Click on **Inputs** in the toolbar on the left
3. Click on **Simple inputs used for Workflow logic**
4. Click on the created input box in the workflow editor
5. Label your input with `{{ include.var_name }}`

# Use a workflow variable to rename a dataset

To use the workflow parameter for renaming a dataset, use the syntax: `${Parameter Name}`. For example, to rename a dataset using the variable used above, proceed with the following steps:
1. Open the workflow editor
2. Click on the tool in the workflow. This will open the tool configuration on the right-hand side of the screen with all details, like parameters etc.
3. Scroll down and click on **Configure Output**
4. In **Rename Dataset**, enter the new dataset name: `Tool run on ${{{ include.var_name }}}`. `Species Name` must match the workflow variable name you created before.

{% else %}

# Create a workflow variable

1. Open the workflow editor
2. Click on **Inputs** in the toolbar on the left
3. Click on **Simple inputs used for Workflow logic**
4. Click on the created input box in the workflow editor
5. Label your input. Example: `Species Name`
Copy link
Member

Choose a reason for hiding this comment

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

I guess it would be useful to overwrite this example name from within tutorials.

See for example https://raw.githubusercontent.com/galaxyproject/training-material/a8c16060c1a15f5109d46a10ca36d0e9dbad1597/faqs/galaxy/datasets_import_via_link.md


# Use a workflow variable to rename a dataset

To use the workflow parameter for renaming a dataset, use the syntax: `${Parameter Name}`. For example, to rename a dataset using the species name, proceed with the following steps:
1. Open the workflow editor
2. Click on the tool in the workflow. This will open the tool configuration on the right-hand side of the screen with all details, like parameters etc.
3. Scroll down and click on **Configure Output**
4. In **Rename Dataset**, enter the new dataset name: `Tool run on ${Species Name}`. `Species Name` must match the workflow variable name you created before.

{% endif %}
Loading