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.

Sign up for GitHub

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

Create beerDEcoded.yaml #7

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

Create beerDEcoded.yaml #7

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8b2621a
Create beerDEcoded.yaml
PlushZ Jun 30, 2021
464a318
Update beerDEcoded.yaml
PlushZ Jul 22, 2021
582a990
Update beerDEcoded.yaml
PlushZ Aug 5, 2021
fd93de0
Update beerDEcoded.yaml
PlushZ Sep 3, 2021
196ae73
Update beerDEcoded.yaml
PlushZ Sep 9, 2021
9f102af
Create readme
PlushZ Sep 9, 2021
53a8253
Add files via upload
PlushZ Sep 9, 2021
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
188 changes: 188 additions & 0 deletions tour/beerDEcoded.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
id: beerDEcoded
name: BeerDEcoded - StreetScienceCommunity
description: BeerDEcoded - StreetScienceCommunity
Copy link
Collaborator

Choose a reason for hiding this comment

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

Workflow finds yeast strains contained in a sequenced beer sample.

title_default: <b>BeerDEcoded</b>
steps:
- title: <b>BeerDEcoded - StreetScienceCommunity</b>
content: >-
Copy link
Collaborator

Choose a reason for hiding this comment

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

idea maybe the introduction could contain a bit more info about the beer microbiome. Like what microorganisms can be found in a beer. Why are they important. A more general introduction is hopefully already done before and then we could have some repetition issues here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I suggest this introduction for the tour:

"Beer contains DNA that comes from its ingredients (hops, malts, yeast) and some hundred microbes. There are 1,000+ yeasts used for brewing and 200+ hop varieties, each one bearing a different DNA and contributing to differentiate its properties.

Thanks for new technologies of sequencing it is easier nowadays to explore the potential of genome sequencing to understand the contribution of various species to product characteristics. The sequencing of the full genome of 157 brewing yeast strains was, for example, recently reported (Gallone B, Steensels J, Prahl T, et al. 2016).

Based on the identification of strains present in beer with desired characteristics, controlled experiments in which the microbial composition of the brew is altered could allow us to investigate if the presence of specific microorganisms affects flavour. The origin of each yeast species can be investigated; i.e. whether they come with the ingredients or from the environment at the production site. Furthermore, plant DNA, such as malt and hop varieties, can be found in beer samples, and the bacterial diversity can be mapped.
"

Copy link
Collaborator

@teresa-m teresa-m Jul 22, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

In general: sounds very good. Maybe break it up into two boxes, so it is not too much text in one.
Some hints:

  • loos the (hops, malts, yeast). In our analysis we only find yeast. Since hops and malts are used early in the brewing process it is very likely that their cells were lysed. The sequencing protocol is not detecting them. To avoid confusion I would delete the (...)
  • The sentence 'Thanks for new technologies...' is not clear to me. Maybe say it in easier words: Thanks to sequencing it is now easyer to find the different genomes contained in a beer sample and investigate their characteristics.
  • The paper is very interesting. :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In general: sounds very good. Maybe break it up into two boxes, so it is not too much text in one.
Some hints:

  • loos the (hops, malts, yeast). In our analysis we only find yeast. Since hops and malts are used early in the brewing process it is very likely that their cells were lysed. The sequencing protocol is not detecting them. To avoid confusion I would delete the (...)
  • The sentence 'Thanks for new technologies...' is not clear to me. Maybe say it in easier words: Tanks to sequencing it is now easyer to find the different genomes contained in a beer sample and investigate their characteristics.
  • The paper is very interesting. :-)

What if we add also information about 3 steps of the process:
"The beerDeCoded process contains 3 consistent steps. The first step is DNA extraction from beer. Then, this DNA can be sequenced. That means that we can obtain the sequence of nucleotides for this specific DNA. Finally, we have to analyze received data in order to know which organisms this DNA is from." And add the process diagram from https://streetscience.community/projects/beerdecoded/
image
And point out that we are currently on the third step?
Or this would be redundant information?

Copy link
Collaborator

Choose a reason for hiding this comment

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

That is a good idea.
In general: It would be good if each box of the tour gets a title, explaining the content of the box. Like this, it will be easy for us to see the flow of the tour.
To this box: It would be good to connect it to the explanation before. E.g. To study the microbiome of beer you need to find out what is inside the beer. Getting this inside can be found by extracting the DNAs of the living organisms (yeast) inside the beer. Now you would also like to 'read' this DNA. This can be achieved by sequencing the DNA.
Having this sequences now enabels us to do a Data analysis, which we will do in the following.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

What is a beer microbiome? There are collections of small living
creatures. These small creatures are called bacteria and they are
everywhere. In our gut, in the soil, even on vending machines. Some of
these bacteria are actually very good for us. And some others can make us
very ill. Bacteria come in different shapes and sizes but they have the
same components. One crucial component is the DNA, the blueprint of life.
The DNA encodes the shape and size and many other things unique for a
bacterial species. Because of the encoding information the DNA can be used
to identify what kind of bacteria the DNA is from. Therefore, within a
sample form soil, our gut or beer one can specify what kind of species are
inside the sample. Follow this tour to learn more about this kind of
analysis. <br><br> Read and Follow the instructions before clicking
<b>'Next'</b>.<br><br> Click <b>'Prev'</b> in case you missed out on any
step."
backdrop: true
- title: <b>Create a new history</b>
element: '#history-new-button'
intro: >-
Let's start by creating a new history.<br>Click on the button <b>'Create
new history'</b><br>
position: left
preclick:
- '#center-panel'
- title: <b>Rename the history</b>
element: '#current-history-panel > div.controls'
intro: Change the name of the new history to <b>'BeerDEcoded'</b>.
position: left
- title: <b>Uploading the input data</b>
content: We need to upload data. We will start with a <b>fastq</b> file.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Idea : incorporate a box shortly repainting the structure of a fastq file. Contains reads. One read is stored in 4 lines. What do the lines mean? ... We should have it explained somewhere before I guess, but for this formats, repetition does not harm.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I suggest to add:

"FASTQ format is a text-based format for storing both a biological sequence and its corresponding quality scores. Both the sequence letter and the quality score are encoded with a single ASCII character for brevity.

A FASTQ file normally uses four lines per sequence.
Line 1 begins with a '@' character and is followed by a sequence identifier and an optional description.
Line 2 is the raw sequence letters.
Line 3 begins with a '+' character and is optionally followed by the same sequence identifier (and any description) again.
Line 4 encodes the quality values for the sequence in Line 2, and must contain the same number of symbols as letters in the sequence.

You can find more info in the Wikipedia article.
"

Copy link
Collaborator

Choose a reason for hiding this comment

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

good :-)

backdrop: true
- title: <b>Uploading the input data</b>
element: .upload-button
intro: >-
We will import fastq into the history we just created.<br><br> Click
<b>'Next'</b> and the tour will open Galaxy Upload Manager and take you to
the Upload screen.
position: right
postclick:
- .upload-button
- title: <b>Uploading the input data</b>
intro: Upload the data by clicking the <b>'Paste/Fetch Data'</b> button.
- title: <b>Uploading the input data</b>
content: >-
Load the data into your history by providing the links or choose your
fastq file from your computer. <br>Click on <b>'Start'</b> to upload the
data into your Galaxy history.
- title: <b>Uploading the input data</b>
content: >-
The upload may take awhile.<br><br> Hit the <b>Close</b> button when you
see that the files are uploaded into your history.
- title: <b>Uploading the input data Complete !</b>
content: 'Now that your data is ready, let''s use some tools.<br>'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Idea Now that your data is ready, let's analyze it!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

backdrop: true
- title: <b>Assign taxonomic classifications</b>
content: >-
One of the key steps in metagenomic data analysis is to identify the taxon
to which the individual reads belong. Taxonomic classification tools are
Copy link
Collaborator

Choose a reason for hiding this comment

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

belongs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

belongs

done

based on microbial genome databases to identify the origin of each
Copy link
Collaborator

Choose a reason for hiding this comment

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

are using microbial ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

are using microbial ...

done

sequence.<br>
backdrop: true
- title: <b>Taxonomic classification with Kraken2</b>
content: >-
To perform the taxonomic classification we will use Kraken2. This tool
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe explain the tool in a more simple linguage. Words like: minimizer method k-mers, deterministic, memory, processing time and dustmasker. It could help to draw the tasks or steps of the tool if this is possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I suggest the explanation:

"This tool uses k-mers (the read’s subsequences of length k) to assign a taxonomic label to the sequence (if possible).
The taxonomic label is assigned based on matches of k-mer content of the considering sequence to the k-mer content of reference genome sequence. The result is a classification of the considering sequence to the most likely taxonomic label. If the k-mer content is not similar to any genomic sequence in the database used, it will not assign any taxonomic label.
"

Copy link
Collaborator

Choose a reason for hiding this comment

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

A figure would be nice. Maybe a pile of readers split in k-mers and then searched in the DB.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

kraken2_simlified - here I tried to create an approximate figure for simplified description of Kraken2 process

Copy link
Collaborator

Choose a reason for hiding this comment

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

This looks very nice. Thanks!

uses the minimizer method to sample the k-mers (all the read’s
subsequences of length k) in a deterministic fashion in order to reduce
memory constumption and processing time. In addition, it masks
low-complexity sequences from reference sequences by using dustmasker.<br>
backdrop: true
- title: <b>Taxonomic classification with Kraken2</b>
element: .toolMenuContainer
intro: Available tools appear here in the <b>tool menu</b>.
position: right
- title: <b>Taxonomic classification with Kraken2</b>
element: '#__BVID__106'
content: >-
You can use <b>'tool search'</b> to locate tools.<br><br> Search for
<b>'Kraken2'</b> and select it.<br><br> Tools may take a couple of moments
to load.
placement: right
- title: <b>Taxonomic classification with Kraken2</b>
element: .toolMenuContainer
intro: >-
Open <b>'Kraken2'</b> tool<br><br> Click <b>'Next'</b> to continue our
tour.
position: right
- title: <b>Assign taxonomic labels with Kraken2</b>
element: 'div[tour_id="use_names"]'
intro: Have a look at the tool's parameters of the <b>'Kraken2'</b> tool.
placement: right
- title: <b>Assign taxonomic labels with Kraken2</b>
intro: >-
Please select the following parameters:<br><br> <b>'Single or paired
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would be nice to have a short explanation for each or some of the parameters to change. It could be marked as side info, so the games do not have to read them, but if they would like to learn more they can.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would be nice to have a short explanation for each or some of the parameters to change. It could be marked as side info, so the games do not have to read them, but if they would like to learn more they can.

I added the info about parameters: Single or paired reads, Confidence and database.

reads'</b>: Single <br> <b>'Input sequences'</b>: Uploaded dataset<br>
<b>'Print scientific names instead of just taxids'</b>: Yes<br>
<b>'Confidence'</b>: 0.0<br> <b>'In “Create Report”'</b>:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<b>'Print a report with aggregrate counts/clade to
file'</b>: Yes<br> &nbsp;&nbsp;&nbsp;&nbsp;<b>'Format report output like
Kraken 1’s kraken-mpa-report'</b>: Yes<br> <b>'Select a Kraken2
database'</b>: fungi2019-03' <br><br>Click <b>'Next'</b> and the tour will
<b>'Execute'</b> the Kraken2 tool for you.'
postclick:
- '#execute'
- title: <b>Assign taxonomic labels with Kraken2</b>
element: '#current-history-panel > div.controls'
intro: >-
Congratulations, you have created two files. It contains Classification
and Report file.<br><br> It will remain stored in your history.<br><br>
Click the <b>'eye'</b> icon to view the data once the history item turns
green.
position: left
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I propose to add one additional step with additonal information about Classification file anf Report file format of Kraken2:
"Additional info:

In classification file each sequence (or sequence pair, in the case of paired reads) classified by Kraken 2 results in a single line of output. Kraken 2's output lines contain five tab-delimited fields; from left to right, they are:

  1. "C"/"U": a one letter code indicating that the sequence was either classified or unclassified.
  2. The sequence ID, obtained from the FASTA/FASTQ header.
  3. The taxonomy ID Kraken 2 used to label the sequence; this is 0 if the sequence is unclassified.
  4. The length of the sequence in bp. In the case of paired read data, this will be a string containing the lengths of the two sequences in bp, separated by a pipe character, e.g. "98|94".
  5. A space-delimited list indicating the LCA mapping of each k-mer in the sequence(s). For example, "562:13 561:4 A:31 0:1 562:3" would indicate that:
    • the first 13 k-mers mapped to taxonomy ID #562
    • the next 4 k-mers mapped to taxonomy ID #561
    • the next 31 k-mers contained an ambiguous nucleotide
    • the next k-mer was not in the database
    • the last 3 k-mers mapped to taxonomy ID #562
    Note that paired read data will contain a "|:|" token in this list to indicate the end of one read and the beginning of another.When Kraken 2 is run against a protein database (see [Translated Search]), the LCA hitlist will contain the results of querying all six frames of each sequence. Reading frame data is separated by a "-:-" token.

Kraken 2's standard sample report file format is tab-delimited with one line per taxon. The fields of the output, from left-to-right, are as follows:
  1. Percentage of fragments covered by the clade rooted at this taxon
  2. Number of fragments covered by the clade rooted at this taxon
  3. Number of fragments assigned directly to this taxon
  4. A rank code, indicating (U)nclassified, (R)oot, (D)omain, (K)ingdom, (P)hylum, (C)lass, (O)rder, (F)amily, (G)enus, or (S)pecies. Taxa that are not at any of these 10 ranks have a rank code that is formed by using the rank code of the closest ancestor rank with a number indicating the distance from that rank. E.g., "G2" is a rank code indicating a taxon is between genus and species and the grandparent taxon is at the genus rank.
  5. NCBI taxonomic ID number
  6. Indented scientific name
The scientific names are indented using space, according to the tree structure specified by the taxonomy.
"

Copy link
Collaborator

Choose a reason for hiding this comment

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

Would be good to also link your source. (Kraken manual)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

- title: <b>Analyze taxonomic assigment</b>
content: >-
Once we have assigned the corresponding taxa to the sequence, the next
step is to properly visualize the data, for which we will use the Krona
pie chart tool (<a href="https://doi.org/10.1186/1471-2105-12-385">Ondov
et al. 2011</a>).<br>
backdrop: true
- title: <b>Adjust dataset format</b>
element: '#__BVID__106'
intro: >-
But before that, we need to adjust the format of the data output from
Kraken2.<br><br> Search and select the <b>'Reverse'</b> tool.
Copy link
Collaborator

Choose a reason for hiding this comment

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

add: It can happen, that the output format of the tool needs to be changed in order for the next tool to read the data. Galaxy offers several "manipulation" tools.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It could help to explain what format changes should happen, so they understand why they are using the tools.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

add: It can happen, that the output format of the tool needs to be changed in order for the next tool to read the data. Galaxy offers several "manipulation" tools.

done

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It could help to explain what format changes should happen, so they understand why they are using the tools.

I added the info about format changes we need and info about what info kraken2 output contains.

position: right
- title: <b>Adjust dataset format</b>
intro: >-
You have selected the Reverse tool.<br> Ensure that for <b>'Input tabular
dataset'</b> you have selected the report output file from
Kraken2.<br><br> <b>'Execute'</b> the Reverse tool when you are ready.
position: right
- title: <b>Adjust dataset format</b>
element: '#__BVID__106'
intro: Search and select the <b>'Replace Text'</b> tool.
position: right
- title: <b>Adjust dataset format</b>
intro: >-
You have selected the Replace Text tool.<br><br> Please select the
following parameters:<br><br> <b>'File to process'</b>: Output dataset
'out_file' from 'Reverse' tool<br> <b>'In “Replacements”'</b>:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<b>'Replacement 1'</b>:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<b>'Find pattern'</b>:
\|<br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<b>'Replace
with:'</b>: \t<br> &nbsp;&nbsp;&nbsp;&nbsp;<b>'Replacement 2'</b>:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<b>'Find pattern'</b>:
[a-z]__<br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<b>'Replace
with:'</b>: Empty <br><br> <b>'Execute'</b> the Reverse tool when you are
ready.
position: right
- title: <b>Visualize the taxonomical classification with Krona</b>
content: >-
<b>Krona</b> allows hierarchical data to be explored with zooming,
multi-layered pie charts. With this tool, we can easily visualize the
composition of the bacterial communities and compare how the populations
of microorganisms are modified according to the conditions of the
environment.
backdrop: true
- title: <b>Visualize metagenomics analysis results</b>
element: '#__BVID__106'
intro: Search and select the <b>'Krona pie chart'</b> tool.
position: right
- title: <b>Visualize metagenomics analysis results</b>
intro: >-
You have selected the 'Krona pie chart' tool.<br><br> Please select the
following parameters:<br><br> <b>'What is the type of your input
data'</b>: Tabular<br> <b>'Input file'</b>: Output dataset 'out_file' from
'Replace Text' tool<br> <b>'Provide a name for the basal rank'</b>:
Root<br> <b>'Combine data from multiple datasets?'</b>: No<br> <br><br>
<b>'Execute'</b> the 'Krona pie chart' tool when you are ready.
position: right
- title: <b>Visualize metagenomics analysis results</b>
element: '#current-history-panel > div.controls'
intro: >-
Let’s take a look at the result by clicking eye icon. Using the search bar
we can check if certain taxa are present.
position: left
preclick:
- '#center-panel'
- title: <b>A tour BeerDEcoded</b>
intro: >-
You have reached the end of the tour.<br><br>Thank you for going through
our tutorial.
backdrop: true