-
Notifications
You must be signed in to change notification settings - Fork 923
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
Delphine-L
wants to merge
3
commits into
galaxyproject:main
Choose a base branch
from
Delphine-L:wkflparam
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %} | ||
# 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` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||
|
||
# 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 %} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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