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

modernization of Galaxy101 #4844

Merged
merged 13 commits into from
Mar 21, 2024
8 changes: 4 additions & 4 deletions faqs/galaxy/datasets_change_datatype.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: Galaxy will try to autodetect the datatype of your files, but you m
area: datasets
box_type: tip
layout: faq
contributors: [bebatut,nsoranzo,hexylena,shiltemann,ajadi-abiola,lldelisle]
contributors: [bebatut,nsoranzo,hexylena,shiltemann,ajadi-abiola,lldelisle,nekrut]
---

* Click on the {% icon galaxy-pencil %} **pencil icon** for the dataset to edit its attributes
* In the central panel, click on the {% icon galaxy-gear %} **Convert** tab on the top
* In the lower part {% icon galaxy-chart-select-data %} **Datatypes**, select {% if include.datatype %}`{{ include.datatype }}`{% else %} your desired datatype {% endif %}
- tip: you can start typing the datatype into the field to filter the dropdown menu
* In the central panel, click {% icon galaxy-chart-select-data %} **Datatypes** tab on the top
* In the {% icon galaxy-chart-select-data %} **Assign Datatype**, select {% if include.datatype %}`{{ include.datatype }}`{% else %} your desired datatype {% endif %} from "*New type*" dropdown
- Tip: you can start typing the datatype into the field to filter the dropdown menu
* Click the **Save** button
7 changes: 5 additions & 2 deletions faqs/galaxy/datasets_change_dbkey.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@ description: You can tell Galaxy which dbkey (e.g. reference genome) your datase
area: datasets
box_type: tip
layout: faq
contributors: [shiltemann,hexylena]
contributors: [shiltemann,hexylena,nekrut]
---

- Click on the {% icon galaxy-pencil %} **pencil icon** for the dataset to edit its attributes
- Click on the "?" next to database indicator:

![UI for changing dbkey]({% link shared/images/datasets_dbkey.svg %})
nekrut marked this conversation as resolved.
Show resolved Hide resolved

- In the central panel, change the **Database/Build** field
- Select your desired database key from the dropdown list{% if include.dbkey %}: `{{ include.dbkey }}`{% endif %}
- Click the **Save** button
10 changes: 5 additions & 5 deletions faqs/galaxy/histories_create_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: Histories are an important part of Galaxy, most people use a new hi
area: histories
box_type: tip
layout: faq
contributors: [bebatut,wm75,shiltemann,hexylena,nomadscientist,nsoranzo]
contributors: [bebatut,wm75,shiltemann,hexylena,nomadscientist,nsoranzo,nekrut]
---

Click the {% icon new-history %} icon at the top of the history panel.
Click the {% icon new-history %} icon at the top of the history panel:

![UI for creating new history]({% link shared/images/history_create_new.svg %})


If the {% icon new-history %} is missing:
1. Click on the {% icon galaxy-gear %} icon (**History options**) on the top of the history panel
2. Select the option **Create New** from the menu
14 changes: 14 additions & 0 deletions faqs/galaxy/histories_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: View a list of all histories
description: This FAQ demonstrates how to list all histories for a given user
area: histories
box_type: tip
layout: faq
contributors: [nekrut]
---

Click the **Switch history** icon at the top of the history panel to bring up a list of all your histories:

![UI for creating new history]({% link shared/images/histories_list.svg %})

nekrut marked this conversation as resolved.
Show resolved Hide resolved

4 changes: 2 additions & 2 deletions faqs/galaxy/histories_sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sharing your history allows others to import and access the datasets, parameters
Access the history sharing menu via the History Options dropdown ({% icon galaxy-history-options %}), and clicking "{% icon history-share %} Share or Publish"

1. **Share via link**
- Open the **History Options** {% icon galaxy-gear %} menu (gear icon) at the top of your history panel and select **Share or Publish**
- Open the **History Options** {% icon galaxy-history-options %} menu at the top of your history panel and select "{% icon history-share %} Share or Publish"
- {% icon galaxy-toggle %} **Make History accessible**
- A **Share Link** will appear that you give to others
- Anybody who has this link can view and copy your history
Expand All @@ -31,5 +31,5 @@ Access the history sharing menu via the History Options dropdown ({% icon galaxy
- Select **Histories shared with me**
- Here you will see all the histories others have shared with you directly

**Note:** If you want to make changes to your history without affecting the shared version, make a copy by going to {% icon galaxy-gear %} *History options* icon in your history and clicking *Copy*
**Note:** If you want to make changes to your history without affecting the shared version, make a copy by going to **History Options** {% icon galaxy-history-options %} icon in your history and clicking *Copy this History*

17 changes: 17 additions & 0 deletions faqs/galaxy/histories_side_by_side_view.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: View histories side-by-side
description: This FAQ demonstrates how to view histories side-by-sde
area: histories
box_type: tip
layout: faq
contributors: [nekrut]
---

To bring up the side-by-side view of Galaxy histories you need to perform the following two steps:

1. Click on "**History options**" drop-down
2. Select "**Show Histories Side-by-Side option**"

![Enabling side-by-side view]({% link shared/images/histories_side_by_side_view.svg %})


1 change: 1 addition & 0 deletions shared/images/datasets_dbkey.svg
nekrut marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions shared/images/histories_list.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions shared/images/histories_side_by_side_view.svg
hexylena marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions shared/images/history_create_new.svg
hexylena marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified topics/introduction/images/history_options_menu.png
Copy link
Member

Choose a reason for hiding this comment

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

space is a nicer background colour, good choice.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added topics/introduction/images/open_wf_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added topics/introduction/images/wf_editor_open.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added topics/introduction/images/workflow_cards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 39 additions & 33 deletions topics/introduction/tutorials/galaxy-intro-101/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ Our objective is to find which exon contains the most SNPs. Therefore we have to
>
> To find intersection we will be using `intersect intervals` tool from [BEDTools](https://bedtools.readthedocs.io/en/latest/content/overview.html) package.
>
> 1. {% tool [bedtools intersect intervals](toolshed.g2.bx.psu.edu/repos/iuc/bedtools/bedtools_intersectbed/2.30.0) %} the intervals of two datasets side-by-side:
> 1. {% tool [bedtools intersect intervals](toolshed.g2.bx.psu.edu/repos/iuc/bedtools/bedtools_intersectbed/2.30.0+galaxy1) %} the intervals of two datasets side-by-side:
>
> Enter the word `intersect` in the search bar of the tool panel, and select the
> tool named `bedtools Intersect intervals`
Expand Down Expand Up @@ -297,7 +297,7 @@ Since each line in our file represents a single overlap between SNP and exon, we

> <hands-on-title>Counting SNPs</hands-on-title>
>
> 1. {% tool [Datamash](toolshed.g2.bx.psu.edu/repos/iuc/datamash_ops/datamash_ops/1.1.0) %} (operations on tabular data):
> 1. {% tool [Datamash](toolshed.g2.bx.psu.edu/repos/iuc/datamash_ops/datamash_ops/1.8+galaxy0) %} (operations on tabular data):
>
> - *"Input tabular dataset"*: select the output dataset from **bedtools intersect intervals** {% icon tool %}
> - *"Group by fields"*: `Column: 4` (the column with the exon IDs)
Expand All @@ -322,7 +322,7 @@ This file contains only two columns. The first contains the exon IDs, and the se
> How many exons are there in total in your file?
>
> > <solution-title></solution-title>
> > Each line now represents a different exon, so you can see the answer to this when you expand the history item, as in the image above. The exact number you see for your dataset may be slightly different due to the updates to the exon and SNPs information in UCSC. In our case the dataset contains 4,242 lines, which is equal to the number of exons overlapped by at least one SNP.
> > Each line now represents a different exon, so you can see the answer to this when you expand the history item, as in the image above. The exact number you see for your dataset may be slightly different due to the updates to the exon and SNPs information in UCSC. In our case the dataset contains 4,241 lines, which is equal to the number of exons overlapped by at least one SNP.
> >
> {: .solution }
{: .question}
Expand All @@ -333,12 +333,13 @@ Now that we have a list of all exons, and the number of SNPs they contain, we wo

> <hands-on-title>Sorting</hands-on-title>
>
> 1. {% tool [Sort](sort1) %} data in ascending or descending order:
> 1. {% tool [Sort](toolshed.g2.bx.psu.edu/repos/bgruening/text_processing/tp_sort_header_tool/1.1.1sort1) %} data in ascending or descending order:
>
> - *"Sort Dataset"*: Output from **Datamash** {% icon tool %}
> - *"on column"*: `Column: 2`
> - *"with flavor"*: `Numerical sort`
> - *"everything in"*: `Descending order`
> - *"Sort Query"*: Output from **Datamash** {% icon tool %}
> - In *"Column selections"* set the following:
> - *"on column"*: `Column: 2`
> - *"in"*: `Descending order`
> - *"Flavor"*: `Fast numeric sort`
>
> 2. Click **Run Tool**
>
Expand Down Expand Up @@ -367,7 +368,7 @@ Let's say we want a list with just the top-5 exons with highest number of SNPs.
>
> 1. {% tool [Select first](toolshed.g2.bx.psu.edu/repos/bgruening/text_processing/tp_head_tool/1.1.0) %} lines from a dataset (head):
>
> - *"File to select"*: The output from **Sort** {% icon tool %}
> - *"File to select"*: The output from **Sort** {% icon tool %} (previous step of the analysis)
> - "*Operation*": `Keep first lines`
> - *"Number of lines"*: `5`
>
Expand All @@ -387,7 +388,7 @@ Congratulations! You have now determined which exons on chromosome 22 have the h
>
> - *"Compare"*: `Exons`
> - *"Using column"*: `Column: 4`
> - *"against"*: the output from **Select first** {% icon tool %}
> - *"against"*: the output from **Select first** {% icon tool %} (previous step of the analysis)
> - *"and column"*: `Column: 1`
> - *"to find"*: `Matching rows of 1st dataset`
>
Expand All @@ -405,7 +406,7 @@ A good way to learn about these exons is to look at their genomic surrounding. T
>
> 1. First, check that the **database** of your latest history dataset is `hg38`. If not, click on the {% icon galaxy-pencil %} pencil icon and modify the **Database/Build:** field to `Human Dec. 2013 (GRCh38/hg38) (hg38)`.
>
> {% snippet faqs/galaxy/datasets_change_dbkey.md dbkey="hg38" %}
> {% snippet faqs/galaxy/datasets_change_dbkey.md dbkey="Human Dec. 2013 (GRCh38/hg38) (hg38)" %}
>
> 2. Second, check that the **format** of your latest history dataset is `bed`. If not, click on the {% icon galaxy-pencil %} pencil icon and modify the **Datatype** field to `bed`.
>
Expand All @@ -428,20 +429,20 @@ UCSC provides a large number of tracks that can help you get a sense of your gen

# Galaxy management

In Galaxy your analyses live in histories such as your current one. Histories can be very large, and you can have as many histories as you want. You can control your histories (switching, copying, sharing, creating a fresh history, etc.) in the {% icon galaxy-gear %} **History Options** menu on the top of the history panel:
In Galaxy your analyses live in histories such as your current one. Histories can be very large, and you can have as many histories as you want. You can control your histories (switching, copying, sharing, creating a fresh history, etc.) in the **History Options** menu on the top of the history panel:

![History options menu](../../images/history_options_menu.png)
![History options menu](../../images/history_options_menu.png "'History options' allows for a variety of history operations")

If you create a new history, your current history does not disappear. If you would like to list all of your histories just use the {% icon galaxy-columns %} Multi-history view:
## Listing your histories

![Overview of histories with their datasets](../../images/101_history-overview.png)
You can create as many histories as you want. If you create a new history, your current history does not disappear. You can view your histories in two ways: (1) as a list or (2) side by side. Two Tip boxes below explain both of these approaches:

Here you can:
- switch between different histories,
- delete a history,
- purge it (i.e. permanently delete it, this action cannot be reversed)
- copy histories
- copy datasets between histories (by dragging and dropping)
{% snippet faqs/galaxy/histories_list.md %}

{% snippet faqs/galaxy/histories_side_by_side_view.md %}


![Overview of histories with their datasets](../../images/histories_side_by_side_view.png "Histories side-by-side view: in this view you drag datasets between histories, switch between histories, create new histories etc.")

You can always return to your analysis view by clicking on Home icon {% icon galaxy-home %} (**Analyze Data** on older versions of Galaxy) in the top menu bar.

Expand All @@ -457,7 +458,7 @@ Galaxy makes this very easy with the `Extract workflow` option. This means any t
>
> This will make the creation of the workflow easier.
>
> 2. Click on {% icon galaxy-gear %} (**History options**) at the top of your history panel and select **Extract workflow**.
> 2. Click on "**History options**" dropdown at the top of your history panel and select **Extract workflow**.
>
> ![`Extract Workflow` entry in the history options menu](../../images/history_menu_extract_workflow.png)
>
Expand All @@ -477,7 +478,7 @@ Galaxy makes this very easy with the `Extract workflow` option. This means any t
>
> 6. Click on **Workflow** in the top menu of Galaxy. Here you have a list of all your workflows. Your newly created workflow should be listed at the top:
>
> ![`Your workflows` list](../../images/101_26.png)
> ![`Your workflows` list](../../images/workflow_cards.png "Workflow are listed in the center pane of the Galaxy interface as cards.")
{: .hands_on}

## The workflow editor
Expand All @@ -488,16 +489,14 @@ We can examine the workflow in Galaxy's workflow editor. Here you can view/chang
>
> 1. Click on the triangle to the right of your workflow name.
>
> ![`Edit` option in the menu for the latest workflow](../../images/101_27.png)
> ![`Edit` option in the menu for the latest workflow](../../images/open_wf_editor.png "To open the interactive workflow editor click the 'Edit' button.")
>
> 2. Select **Edit** to launch the workflow editor. You should see something like this:
>
> ![Workflow editor](../../images/101_28.png)
> ![Workflow editor](../../images/wf_editor_open.png "Workflow editor interface. It can be used for creation and editing of workflows of any complexity.")
>
> When you click on a workflow step, you will get a view of all the parameter settings for that tool on the right-hand side of your screen.
>
> {% snippet faqs/galaxy/workflows_hide_intermediate_steps.md %}
>
> 3. Re-arrange the boxes so you can clearly see the data flow. The default automatic layout hides some of the connections due to overlapping and box placement.
>
> 4. Make sure the **check boxes** for `out_file1` in the `Select First` and `Compare two Datasets` tools are selected. Make sure that everything else is not selected.
Expand All @@ -515,7 +514,7 @@ We can examine the workflow in Galaxy's workflow editor. Here you can view/chang
> - In the menu on the right click on `Configure Output: 'out_file1'`
> - Under `Rename dataset`, and enter a descriptive name for the output dataset like `Top 5 exon IDs`
>
> ![Rename the output of the `Select first` tool step](../../images/101_34.png)
> ![Rename the output of the `Select first` tool step](../../images/configure_wf_output.png "The datasets generated by the workflow execution can be automatically renamed using the 'Rename dataset' option")
>
> 7. **Repeat** this for the output of the `Compare two Datasets` tool, naming it `Top 5 exons`
>
Expand All @@ -539,10 +538,17 @@ Now that we have built our workflow, let's use it on some different data. For ex
>
> {% snippet faqs/galaxy/histories_create_new.md %}
>
> 2. We will need the list of exons again. We don't have to get this from UCSC again, we can just **copy** it from our previous history. The easiest way to do this is to go to the {% icon galaxy-columns %} history overview. Here you can just drag and drop datasets from one history to another.
> 2. We will need the list of exons again. We don't have to get this from UCSC again, we can just **copy** it from our previous history. To do this:
>
> - Bring up a list of all you histories:
>
> {% snippet faqs/galaxy/histories_list.md %}
>
> ![Drag and drop of `Exons` dataset in the history overview](../../images/copying_data.gif)
> - Display the "Galaxy 101" history in the Center pane by clicking "Open in Center pane" button:
> ![Opening a history in the center pane](../../images/open_in_center_pane_button.png)
>
> - Drag an drop `Exons` dataset into the empty history created at step 1
> ![Drag and drop of `Exons` dataset in the history overview](../../images/drag_n_drop_dataset.gif)
> 3. Click the Home icon {% icon galaxy-home %} (or **Analyze Data** on older Galaxy versions) at the top to return to the main analysis window
>
> 4. {% tool [Upload Data](upload1) %} the Repeats file from [Zenodo](https://doi.org/10.5281/zenodo.4104428)
Expand Down Expand Up @@ -580,7 +586,7 @@ Now that we have built our workflow, let's use it on some different data. For ex
>
> 6. Open the **workflow menu** (top menu bar). Find the workflow you made in the previous section, and select the option `Run`.
>
> ![`Run` option in the workflow menu](../../images/101_37.png)
> ![`Run` option in the workflow menu](../../images/run_workflow_button.png)
>
> {% snippet faqs/galaxy/workflows_run.md %}
>
Expand All @@ -591,7 +597,7 @@ Now that we have built our workflow, let's use it on some different data. For ex
> - {% icon param-file %} *"Exons"*: the `Exons` file you copied from our previous history
> - {% icon param-file %} *"Features"*: the `Repeats` file we downloaded from UCSC
>
> ![Settings for running the workflow](../../images/101_38.png)
> ![Settings for running the workflow](../../images/workflow_setting_inputs.png)
>
> > <comment-title>Potential workflow issues</comment-title>
> >
Expand All @@ -601,7 +607,7 @@ Now that we have built our workflow, let's use it on some different data. For ex
>
> 8. Once the workflow has started, you will initially be able to see all its steps, but the unimportant intermediates will disappear after they complete successfully:
>
> ![Datasets appearing in the history](../../images/101_39.png)
> ![Datasets appearing in the history](../../images/workflow_running.png)
{: .hands_on}

> <comment-title>Unhiding hidden datasets</comment-title>
Expand Down
Loading