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

Tutorial transcript #443

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

Tutorial transcript #443

wants to merge 6 commits into from

Conversation

anikde07
Copy link
Collaborator

Draft Pull request for a first version of the transcript.
To do:

  1. Clean the last paragraph
  2. Screenshot and markup website

Copy link
Collaborator

@LeaSeep LeaSeep left a comment

Choose a reason for hiding this comment

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

I feel like there are still a lot of grammar, language issues - please revise

title: "Transcript of Tutorial"
output: html_notebook
---
Welcome to cOmicsArt - Customizable Omic Analysis and Reporting Tool. This tutorial is going to show you how to use this application to aid in your statistical analysis.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Welcome to cOmicsArt - Customizable Omic Analysis and Reporting Tool. This tutorial is going to show you how to use this application to aid in your statistical analysis.
Welcome to cOmicsArt - Customizable Omic Analysis and Reporting Tool. This tutorial is going to show you how to use this application to guide your statistical analysis.

Welcome to cOmicsArt - Customizable Omic Analysis and Reporting Tool. This tutorial is going to show you how to use this application to aid in your statistical analysis.
This tutorial is self-contained but can also be used to follow along with the YouTube tutorial.

Comics art is designed is in a tabular format. In the beginning you only see the data selection but if you upload your data and go through the steps progressively more
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Comics art is designed is in a tabular format. In the beginning you only see the data selection but if you upload your data and go through the steps progressively more
cOmicsArt is designed is in a tabular format. In the beginning you only see the 'data selection'-tab but if you upload your data and go through the steps progressively more


## Uploading Data ##

The data will be uploaded with three CSV files. The first one is the data matrix showing the counts on the rows there are the entities for example genes on the columns
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The data will be uploaded with three CSV files. The first one is the data matrix showing the counts on the rows there are the entities for example genes on the columns
The data can be uploaded using three CSV files.
The first file is the data matrix showing the counts on the rows there are the entities for example genes on the columns

This is not proper english

## Uploading Data ##

The data will be uploaded with three CSV files. The first one is the data matrix showing the counts on the rows there are the entities for example genes on the columns
they are the samples. The sample table shows you meta information on the samples while the entity table shows you any information on the entities you have.
Copy link
Collaborator

Choose a reason for hiding this comment

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

both is metadata

@LeaSeep LeaSeep marked this pull request as ready for review February 16, 2025 13:42
@LeaSeep
Copy link
Collaborator

LeaSeep commented Feb 16, 2025

I have pushed a commit with adjustments of the text to guide you what I was expecting. Please revise the entire transcript, by reading through it and adjust for actual readability it still contains too many language errors.
Deviations from what is actually said in the tutorial are totally acceptable - sentences should be more concise mostly

@anikde07
Copy link
Collaborator Author

I have revised the transcript for all sections except Pre-Processing and Sample Correlation.
Let me know if the revised sections now look better and what further changes need to be made to them.
According to these I will revise the Pre-Processing and Sample Correlation sections.

Copy link
Collaborator

@LeaSeep LeaSeep left a comment

Choose a reason for hiding this comment

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

Please address all comments and suggestions.
Additioanlly add at the top a disclaimer that the tutorial was based on cOmicsArt v.1.0.0 and that some parts of the interface e.g. where to find options has changed and additional options also added but that the majority also within this tutorial can be readily still used


To upload your data, you'll need three CSV files:

- **The data matrix**, where rows represent entities (like genes) and columns represent samples. The values contain count data.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- **The data matrix**, where rows represent entities (like genes) and columns represent samples. The values contain count data.
- **The data matrix**, where rows represent entities (like genes) and columns represent samples. The values contain e.g. count data.


[Caption of screenshot] This documentation shows you how to upload your data via the file input.

We choose an example data set which is also available for download:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
We choose an example data set which is also available for download:
We choose the example data set which is also available for download:

At the bottom of the screen there are a multitude of checks where you can check whether your data looks as it should be.
Green signifies that the dataset is fine, whereas red means you need to go into your data and change things and orange means the dataset has some issues but the program can handle it - for example this dataset contains some entries which are missing and the application will just remove those entities from the table.

After the inspection of the data is complete, click on "Upload new data" and now you should see your result in the right hand section of the panel.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
After the inspection of the data is complete, click on "Upload new data" and now you should see your result in the right hand section of the panel.
After the inspection of the data is completed, click on "Upload new data" and now you should see your result in the right hand section of the panel.


For the sample selection we first choose among the columns present in the sample table. For example we can choose the cells, condition, experiment or the sample.
If we select sample, additionally we can select only specific samples we want to include the data analysis. Perhaps there are strong reasons to exclude some samples. By clicking on the specific sample, it removes all other samples and only uses the selection of samples we made.
If we select condition, we can do a similar selection. Here it's treated or untreated but you have multiple conditions you might want to only check one of them.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
If we select condition, we can do a similar selection. Here it's treated or untreated but you have multiple conditions you might want to only check one of them.
If we select condition, we can do a similar selection. Here, it's treated or untreated but you have multiple conditions you might want to only check one of them.

Here you can see the design choice for the layout, which remains consistent for the other the data analysis windows we will cover:
The left side consists of the sidebar with all the available options. Additionally, the options which need re-computation on being changed are separated from those which do not such re-computation by a separating line.

For example we can choose the vst_DESeq, and then choose the genes. [?]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does not make sense

Copy link
Collaborator Author

@anikde07 anikde07 Mar 4, 2025

Choose a reason for hiding this comment

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

Do you mean in the last line mentioning vst_DESeq? If this is the part then, I could not understand what Paul meant by choosing vst_DESeq and then choosing the genes.


Example:
We select the following three comparisons: "N052611:N61311", "N080611:N61311", "N061011:N61311".
For this comparison, when we look at adjusted p-values, the result visualization is currently empty because we have nothing significant.
Copy link
Collaborator

Choose a reason for hiding this comment

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

try to stick to one notation for writing 'p-values'
ABove there is also 'P values', 'p values' etc

We select the following three comparisons: "N052611:N61311", "N080611:N61311", "N061011:N61311".
For this comparison, when we look at adjusted p-values, the result visualization is currently empty because we have nothing significant.

But if we choose to look at raw P values by changing the type of significance to "significant unadusted", there is now a plot which shows the genes which are significant in each of the comparisons.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
But if we choose to look at raw P values by changing the type of significance to "significant unadusted", there is now a plot which shows the genes which are significant in each of the comparisons.
But if we choose to look at raw P values by changing the type of significance to "significant unadjusted", there is now a plot which shows the genes which are significant in each of the comparisons.

First, we select between raw or pre-processed data and then select the gene to visualise from the list of available genes under "Select the Gene from the list".
On selecting the "Get Single Gene Visualisation", we get box plots or dot plots. Box plots will only be visible if you have more than 3 samples per group. If there are fewer than 4 samples, only dots will be displayed.

You can also group the samples based on the annotation categories by choosing the annotation category from the list of available categories under "Choose the groups to show the data for"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
You can also group the samples based on the annotation categories by choosing the annotation category from the list of available categories under "Choose the groups to show the data for"
You can also group the samples based on the annotation categories by choosing the annotation category from the list of available categories under "Choose the groups to show the data for".


For each gene set selected a tab will be visible within which you can see the enrichment.

[Again for the tables you can download the tables and for the plots you have sent only through report get the underlying R code to reproduce this in R directly or save the plot as it is the]
Copy link
Collaborator

Choose a reason for hiding this comment

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

What is this bracket notation for?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The bracket notation is for the lines which are repeated a couple of times for example Paul goes through how to save and report the plots a couple of times across the various tabs and I was not sure if we should keep this reporting section in the transcript every-time it is mentioned in the tutorial


We now come to the Heatmap tab.

The Heatmap displays the count matrix in a clustered fashion and We now can select what entities we want to plot.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The Heatmap displays the count matrix in a clustered fashion and We now can select what entities we want to plot.
The Heatmap displays the count matrix in a clustered fashion and we now can select what entities we want to plot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants