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

Updating short tutorial #4386

Merged
merged 45 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
4437107
Updating short tutorial
nekrut Oct 6, 2023
e80af9e
Add files via upload
nekrut Oct 6, 2023
6031235
Merge branch 'galaxyproject:main' into short_vgp_tutorial_edits_an
nekrut Oct 9, 2023
74256f2
linking tio new workflow image
nekrut Oct 9, 2023
6e970a6
Merge branch 'galaxyproject:main' into short_vgp_tutorial_edits_an
nekrut Oct 16, 2023
b79aad6
first major part of restructureing. Very much WIP
nekrut Oct 25, 2023
cd304f8
major restructuring WIP
nekrut Oct 25, 2023
8b26037
more editing
nekrut Oct 31, 2023
86afc49
up to scaffolding now
nekrut Nov 2, 2023
4c982d8
new pretext images
nekrut Nov 3, 2023
76b0296
draft is done. Need to add workflows and polish
nekrut Nov 3, 2023
b30a8de
more editing
nekrut Nov 3, 2023
47c4276
new faqs and almost finished wf section of the tutorial
nekrut Nov 6, 2023
1727d3f
added workflows
nekrut Nov 7, 2023
938efbc
fixing errors
nekrut Nov 7, 2023
4c52ec6
more fixes
nekrut Nov 7, 2023
493ddea
first major part of restructureing. Very much WIP
nekrut Oct 25, 2023
32df21c
Add files via upload
nekrut Oct 6, 2023
90194f0
more editing
nekrut Oct 31, 2023
a22e915
up to scaffolding now
nekrut Nov 2, 2023
5800ab9
new pretext images
nekrut Nov 3, 2023
837e54e
draft is done. Need to add workflows and polish
nekrut Nov 3, 2023
eb5dc33
more editing
nekrut Nov 3, 2023
460c457
new faqs and almost finished wf section of the tutorial
nekrut Nov 6, 2023
c5d0a2d
added workflows
nekrut Nov 7, 2023
1823324
fixing errors
nekrut Nov 7, 2023
78d036d
more fixes
nekrut Nov 7, 2023
bd74213
Merge branch 'short_vgp_tutorial_edits_an' of github.com:nekrut/train…
nekrut Nov 9, 2023
7db299b
edits in response to helena and saskia
nekrut Nov 9, 2023
1dc0392
Merge branch 'main' into short_vgp_tutorial_edits_an
shiltemann Nov 9, 2023
47abb12
Merge branch 'main' into short_vgp_tutorial_edits_an
shiltemann Nov 9, 2023
a40160c
new list image and dockstore links
nekrut Nov 16, 2023
99c9726
wf import section is finished
nekrut Nov 17, 2023
6d19816
fixed faqs
nekrut Nov 17, 2023
59a3fdf
fixed linting errors
nekrut Nov 21, 2023
b42004c
added proper link to into materials
nekrut Nov 21, 2023
68c4451
new workflow list image and minor tweaks
nekrut Nov 21, 2023
b516a8b
removed cross links. I will add them once the full tutorial is updated
nekrut Nov 21, 2023
1c4ebc6
Merge remote-tracking branch 'origin/main' into short_vgp_tutorial_ed…
nekrut Nov 21, 2023
580d915
add border to figures
shiltemann Nov 27, 2023
3d9a6b6
fix heading levels
shiltemann Nov 27, 2023
36b7fa1
update/move/unify FAQs
shiltemann Nov 27, 2023
225959c
tweak FAQ
shiltemann Nov 27, 2023
82f2f3b
rework more FAQs
shiltemann Nov 27, 2023
0ab0e83
format FAQ
shiltemann Nov 27, 2023
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
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ icon-tag:
cofest: fas fa-users
comment: far fa-comment-dots
congratulations: far fa-thumbs-up
copy: far fa-copy
curriculum: fas fa-graduation-cap
details: fas fa-info-circle
docker_image: fab fa-docker
Expand Down
4 changes: 2 additions & 2 deletions _plugins/jekyll-figurify.rb
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ def figurify(page, site)
image = insert_image(url, alt, style, dimensions, actual_path)

%(
<figure id="figure-#{num_figure}" style="max-width: 90%; margin:auto;">
<figure id="figure-#{num_figure}" style="max-width: 90%;">
#{image}
<a target="_blank" href="#{url}" rel="noopener noreferrer"><small>Open image in new tab</small></a>
<a target="_blank" href="#{url}" rel="noopener noreferrer"><small>Open image in new tab</small></a><br/><br/>
<figcaption>
<span class="figcaption-prefix"><strong>#{prefix}#{num_figure}</strong>:</span> #{title}
</figcaption>
Expand Down
11 changes: 9 additions & 2 deletions assets/css/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,9 @@ div.main-content {

figure {
text-align: center;
margin: 1rem 2rem;
margin: 2rem;
border: thin silver solid;
padding: 1rem;

& > img {
margin-bottom: 1rem;
Expand All @@ -374,6 +376,11 @@ figure {
}
}

@media (max-width:992px) {
figure {
margin: 1rem;
}
}

:not(pre) > code {
color: var(--code-foreground);
Expand Down Expand Up @@ -1665,7 +1672,7 @@ figure > a[target="_blank"]::after {
justify-content: space-between;
align-items: flex-end;
row-gap: 1em;

figure {
max-width: 20em;
margin: 0rem 0.5rem;
Expand Down
2 changes: 2 additions & 0 deletions faqs/galaxy/collections_build_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ contributors: [shiltemann, hexylena]
* Enter a name for your collection
* Click **Create List** to build your collection
* Click on the checkmark icon at the top of your history again

![Creating a simple collection]({{site.baseurl}}/faqs/galaxy/images/create_simple_list.png "Creating a simple (list) collection in Galaxy's history")
13 changes: 13 additions & 0 deletions faqs/galaxy/datasets_upload_from_genomeark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Upload datasets from GenomeArk
area: data upload
box_type: tip
layout: faq
contributors: [nekrut]
---

1. Open the file {% icon galaxy-upload %} __upload__ menu
2. Click on **Choose remote files** tab
3. Click on the **Genome Ark** button and then click on **species**

You can find the data by following this path: `/species/${Genus}_${species}/${specimen_code}/genomic_data`. Inside a given datatype directory (*e.g.* `pacbio`), select all the relevant files individually until all the desired files are highlighted and click the <kbd>Ok</kbd> button. Note that there may be multiple pages of files listed. Also note that you may not want every file listed.
Binary file added faqs/galaxy/images/create_simple_list.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 faqs/galaxy/images/upload_fasta_via_url.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 faqs/galaxy/images/upload_fastqsanger_via_url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions faqs/galaxy/workflows_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@
- Option 1: Paste the URL of the workflow into the box labelled *"Archived Workflow URL"*
- Option 2: Upload the workflow file in the box labelled *"Archived Workflow File"*
- Click the **Import workflow** button

Below is a short video demonstrating how to import a workflow from GitHub using this procedure:

<p align="center"><iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/hoP36Te5wko" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></p>

Check warning on line 18 in faqs/galaxy/workflows_import.md

View workflow job for this annotation

GitHub Actions / lint

[rdjsonl] reported by reviewdog 🐶 Instead of embedding IFrames to YouTube contents, consider adding this video to the [GTN Video Library](https://github.com/gallantries/video-library/issues/) where it will be more visible for others. Raw Output: {"message":"Instead of embedding IFrames to YouTube contents, consider adding this video to the [GTN Video Library](https://github.com/gallantries/video-library/issues/) where it will be more visible for others.","location":{"path":"./faqs/galaxy/workflows_import.md","range":{"start":{"line":18,"column":19},"end":{"line":18,"column":287}}},"severity":"WARNING","code":{"value":"GTN:002","url":"https://github.com/galaxyproject/training-material/wiki/Error-Codes#gtn002"},"suggestions":[{"text":"","range":{"start":{"line":18,"column":19},"end":{"line":18,"column":287}}}]}

26 changes: 26 additions & 0 deletions faqs/galaxy/workflows_import_from_dockstore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Import workflows from DockStore
area: workflows
box_type: tip
layout: faq
contributors: [nekrut]
---

[Dockstore](https://dockstore.org/) is a free and open source platform for sharing reusable and scalable analytical tools and workflows.

1. Go to [DockStore](https://dockstore.org).
2. Select any Galaxy workflow you want to import.
3. Click on "Galaxy" dropdown within the "Launch with" panel located in the upper right corner.
4. Select a galaxy instance you want to launch this workflow with.
5. You will be redirected to Galaxy and presented with a list of workflow versions.
6. Click the version you want (usually the latest labelled as "main")
7. You are done!

> <warning-title>Make sure you are logged in!</warning-title>
> Ensure that you are logged in into your Galaxy account!
{: .warning}

The following short video walks you through this uncomplicated procedure:

<p align="center"><iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/K2wFrSLFpa0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></p>

Check warning on line 25 in faqs/galaxy/workflows_import_from_dockstore.md

View workflow job for this annotation

GitHub Actions / lint

[rdjsonl] reported by reviewdog 🐶 Instead of embedding IFrames to YouTube contents, consider adding this video to the [GTN Video Library](https://github.com/gallantries/video-library/issues/) where it will be more visible for others. Raw Output: {"message":"Instead of embedding IFrames to YouTube contents, consider adding this video to the [GTN Video Library](https://github.com/gallantries/video-library/issues/) where it will be more visible for others.","location":{"path":"./faqs/galaxy/workflows_import_from_dockstore.md","range":{"start":{"line":25,"column":19},"end":{"line":25,"column":287}}},"severity":"WARNING","code":{"value":"GTN:002","url":"https://github.com/galaxyproject/training-material/wiki/Error-Codes#gtn002"},"suggestions":[{"text":"","range":{"start":{"line":25,"column":19},"end":{"line":25,"column":287}}}]}
{: .hands_on}
28 changes: 16 additions & 12 deletions faqs/galaxy/workflows_import_from_workflowhub.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,25 @@
area: workflows
box_type: tip
layout: faq
contributors: [gallardoalba, abueg]
contributors: [gallardoalba, abueg, nekrut]
---

[WorkflowHub](https://workflowhub.eu/) is a workflow management system which allows workflows to be FAIR (Findable, Accessible, Interoperable, and Reusable), citable, have managed metadata profiles, and be openly available for review and analytics.

> <hands-on-title> Import a workflow </hands-on-title>
>
> 1. Click on the **Workflow** menu, located in the top bar.
> 2. Click on the **Import** button, located in the right corner.
> 3. In the section "Import a Workflow from Configured GA4GH Tool Registry Servers (e.g. Dockstore)", click on **Search form**.
>
> 4. In the **TRS Server: *workflowhub.eu*** menu you should type {% if include.filter %}`{{ include.filter }}`{% else %}your query.{% endif %}
> ![galaxy TRS workflow search field, name:vgp is entered in the search bar, and five different workflows all labelled VGP are listed]({% link topics/assembly/images/vgp_assembly/workflow_list.png %})
> 5. Click on the desired workflow, and finally select the latest available version.
{: .hands_on}
> <warning-title>Make sure you are logged in!</warning-title>
> Ensure that you are logged in into your Galaxy account!
{: .warning}

1. Click on the **Workflow** menu, located in the top bar.
2. Click on the **Import** button, located in the right corner.
3. In the section "Import a Workflow from Configured GA4GH Tool Registry Servers (e.g. Dockstore)", click on **Search form**.
4. In the **TRS Server: *workflowhub.eu*** menu you should type {% if include.filter %}`{{ include.filter }}`{% else %}your query.{% endif %}
![galaxy TRS workflow search field, name:vgp is entered in the search bar, and five different workflows all labelled VGP are listed]({% link topics/assembly/images/vgp_assembly/workflow_list.png %})
5. Click on the desired workflow, and finally select the latest available version.

After that, the imported workflows will appear in the main workflow menu. In order to run the workflow, just need to click in the {% icon workflow-run %} **Run workflow** icon.

After that, the imported workflows will appear in the main workflow menu. In order to initialize the workflow, we just need to click in the {% icon workflow-run %} **Run workflow** icon.
Below is a short video showing this uncomplicated procedure:

<p align="center"><iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/hoP36Te5wko" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></p>

Check warning on line 26 in faqs/galaxy/workflows_import_from_workflowhub.md

View workflow job for this annotation

GitHub Actions / lint

[rdjsonl] reported by reviewdog 🐶 Instead of embedding IFrames to YouTube contents, consider adding this video to the [GTN Video Library](https://github.com/gallantries/video-library/issues/) where it will be more visible for others. Raw Output: {"message":"Instead of embedding IFrames to YouTube contents, consider adding this video to the [GTN Video Library](https://github.com/gallantries/video-library/issues/) where it will be more visible for others.","location":{"path":"./faqs/galaxy/workflows_import_from_workflowhub.md","range":{"start":{"line":26,"column":19},"end":{"line":26,"column":287}}},"severity":"WARNING","code":{"value":"GTN:002","url":"https://github.com/galaxyproject/training-material/wiki/Error-Codes#gtn002"},"suggestions":[{"text":"","range":{"start":{"line":26,"column":19},"end":{"line":26,"column":287}}}]}
{: .hands_on}
Binary file modified topics/assembly/images/vgp_assembly/BUSCO_full_table.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.
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/assembly/images/vgp_assembly/genomescope_plot.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.
Binary file modified topics/assembly/images/vgp_assembly/imported_workflows.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.
1 change: 1 addition & 0 deletions topics/assembly/images/vgp_assembly/making_list.svg
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.
1 change: 1 addition & 0 deletions topics/assembly/images/vgp_assembly/vgp_wfs.svg
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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Upload fasta datasets via links
area: data upload
box_type: tip
layout: faq
contributors: [nekrut]
---

Uploading `fasta` or `fasta.gz` datasets via URL.

![UploadAnimatedPng]({{site.baseurl}}/faqs/galaxy/images/upload_fasta_via_url.png)


Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ layout: faq
contributors: [nekrut]
---

Uploading `fastqsanger` or `fastqsanger.gz` datasets via URL.

1. Click on **Upload Data** on the top of the left panel:

Expand All @@ -24,3 +25,10 @@ contributors: [nekrut]
![ChangeTypeDropDown]({{site.baseurl}}/faqs/galaxy/images/paste_fetch_set_data_type.png):


> <warning-title>Danger: Make sure you choose corect format!</warning-title>
> When selecting datatype in "**Type (set all)**" dropdown, make sure you select `fastaqsanger` or `fastqsanger.gz` BUT NOT `fastqcssanger` or anything else!
{: .warning}

![UploadAnimatedPng]({{site.baseurl}}/faqs/galaxy/images/upload_fastqsanger_via_url.png)


Loading
Loading