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

New CiteSeq Tool Tutorial--DRAFT-WIP #4475

Draft
wants to merge 46 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
5712659
beginings of citeseq tutorial
Camila-goclowski Nov 2, 2023
f1b6090
ansible-guest space @2484
Camila-goclowski Nov 2, 2023
5567f5e
Folder name fixed & plots added
Camila-goclowski Nov 2, 2023
dd1ae8c
/workspace/training-material/_layouts/base.html
Camila-goclowski Nov 2, 2023
e49f622
removed tutorial requirements
Camila-goclowski Nov 2, 2023
1309804
moved to multiomics section
Camila-goclowski Nov 2, 2023
12c8500
plot 1 resized and preamble reformat
Camila-goclowski Nov 2, 2023
fe60ae9
more plots
Camila-goclowski Nov 2, 2023
53d2843
hands on box opened
Camila-goclowski Nov 2, 2023
81f5802
jekyl attempted fix @ line 11
Camila-goclowski Nov 2, 2023
17fc580
fixed broken box?
Camila-goclowski Nov 2, 2023
0ca2338
added correct link to FPE reference
Camila-goclowski Nov 2, 2023
5237311
gx-get comment box fix
Camila-goclowski Nov 2, 2023
293c737
Mostly done!
Camila-goclowski Nov 2, 2023
d1cf23a
rest of plots
Camila-goclowski Nov 2, 2023
c733dd4
removed ansible-galaxy change
Camila-goclowski Nov 2, 2023
36c734a
unbolded note headers and backed up one head lev
Camila-goclowski Nov 2, 2023
ed998b0
unbolded option 2 header
Camila-goclowski Nov 2, 2023
7d7155a
Datatypes --> Datasets
Camila-goclowski Nov 2, 2023
20d7ad3
move to RStudio header added
Camila-goclowski Nov 2, 2023
4ba1afc
redid headers
Camila-goclowski Nov 2, 2023
59d0f4b
moved data links to hands on box
Camila-goclowski Nov 2, 2023
4426cd9
reformat data links box
Camila-goclowski Nov 2, 2023
b771519
Merge branch 'galaxyproject:main' into CiteSeq
Camila-goclowski Nov 2, 2023
2170c6a
Merge branch 'galaxyproject:main' into CiteSeq
Camila-goclowski Nov 16, 2023
2f37459
reformat import via link
Camila-goclowski Nov 17, 2023
5c0f958
toc fixes
Camila-goclowski Nov 17, 2023
7a46e9d
line edits
Camila-goclowski Nov 17, 2023
50ad6e6
Merge branch 'galaxyproject:main' into CiteSeq
Camila-goclowski Nov 20, 2023
4a1d479
fixed runlog warning box
Camila-goclowski Nov 20, 2023
3ce61a2
Correct tool parameters & history still: plots
Camila-goclowski Nov 20, 2023
ca580a4
Merge branch 'galaxyproject:main' into edits_cite-seq
nomadscientist Nov 29, 2023
984fb16
fix bib text and title organisation
nomadscientist Nov 29, 2023
35fea28
minor edits
nomadscientist Nov 29, 2023
8a04637
fix bib
nomadscientist Nov 29, 2023
7f22f06
remove unchanging tool parameters
nomadscientist Nov 29, 2023
f6579e6
change comment to details
nomadscientist Nov 29, 2023
db10a5c
reorder data inputs to align with text
nomadscientist Nov 29, 2023
cc02145
distinguishing headers
nomadscientist Nov 29, 2023
1ed6ced
change formats
nomadscientist Nov 29, 2023
0a280d7
fix formats
nomadscientist Nov 29, 2023
2dcb830
Merge branch 'galaxyproject:main' into CiteSeq
Camila-goclowski Nov 29, 2023
49d5c94
Merge branch 'galaxyproject:main' into edits_cite-seq
nomadscientist Nov 29, 2023
58b6914
Merge branch 'CiteSeq' into edits_cite-seq
Camila-goclowski Nov 30, 2023
6d1963e
Merge pull request #2 from nomadscientist/edits_cite-seq
Camila-goclowski Nov 30, 2023
669eeef
Merge branch 'galaxyproject:main' into CiteSeq
Camila-goclowski Nov 30, 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
2 changes: 1 addition & 1 deletion _layouts/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
{% endif %}
</body>
</html>
</html>
21 changes: 21 additions & 0 deletions faqs/galaxy/interactive_tools_rstudio_gx_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Use gx_get
area: interactive tools
box_type: hands_on
layout: faq
contributors: [Camila-goclowski]
---

><tip-title>How to import datasets from Galaxy to RStudio</tip-title>
>
> RStudio in Galaxy comes with a `gx_get()` function. This is critical for moving datasets from your Galaxy history into Galaxy RStudio. The function outputs the file path from which you access your data via RStudio.
>
> To use it, use the numbered position of the dataset you are looking to import. For example:
>
> If we want to find the first dataset in your history, run the following command:
> ```r
> gx_get(1)
> ```
>The result of this command will be a file path to the first dataset in your Galaxy history. Use that file path for future importing commands.
>
{: .tip}
2 changes: 1 addition & 1 deletion topics/admin/tutorials/ansible-galaxy/tutorial.md
Camila-goclowski marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -2483,7 +2483,7 @@ With Ansible, upgrading Galaxy to a new release is incredibly easy. Here is a co
--- a/group_vars/galaxyservers.yml
+++ b/group_vars/galaxyservers.yml
@@ -345,7 +345,7 @@ galaxy_instance_hostname: usegalaxy.eu

-
galaxy_repo: 'https://github.com/usegalaxy-eu/galaxy.git'
-galaxy_commit_id: 'release_19.05'
+galaxy_commit_id: 'release_19.09'
Expand Down
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.
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.
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.
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,3 @@
---
layout: faq-page
---
120 changes: 120 additions & 0 deletions topics/single-cell/tutorials/scCiteSeq-RStudio/preamble.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# Introduction
> <comment-title></comment-title>
> This tutorial is significantly based on the Seurat documentation({% cite Satija2015 %}) as well as Seurat's vignette entitled [Using Seurat with multimodal data](https://satijalab.org/seurat/articles/multimodal_vignette).
{: .comment}

> <agenda-title> Getting to RStudio</agenda-title>
>
> In this tutorial, we will cover:
>
> 1. TOC
> {:toc}
> [Or skip ahead to analyses in RStudio](#skipahead)
{: .agenda}

# Cite-Seq Overview
Multiomic analyses are a new and exciting way to understand the world of biology through bioinformatics! Cite-Seq ({% cite Satija&Smibert2017 %}) is one example of such multimodal technologies. Cite-Seq enables us to measure single cell transcriptomes and cell surface proteins simultaneously. Transcriptomic measurements are achieved via RNA sequencing techniques and the surface protein abundance measurements are quantified via DNA barcoded antibodies. As of current, Cite-Seq boasts its ability to tag up to 125 surface proteins at a time!

Seurat has kept up to date with the capacities of multimodal technologies such as Cite-Seq, which means once you've familiarized yourself with Seurat, you can seamlessly continue to use the package to analyze and explore many other types multimodal single-cell datasets.

><comment-title></comment-title>
>Check out [Filter, Plot, and Explore with Seurat]({% link topics/single-cell/tutorials/scrna-case_FilterPlotandExploreRStudio %}) to start doing so in RStudio with an scRNA-seq dataset!
{: .comment}

Before we can start exploring, we'll process our transcriptomic and surface protein measurements into a Seurat object. The hardworking Galaxy programmers have kindly optimized the Seurat tool to include Cite-Seq functionality. This enables us to input our raw csv files and the tool will output Seurat objects, which are much easy to explore!

><comment-title></comment-title>
>If you're interested in what the Seurat tool is doing behind the scenes, check out Seurat's [Using Seurat with multimodal data](https://satijalab.org/seurat/articles/multimodal_vignette) vignette. The first section of the tutorial is what the Cite-Seq enabled Seurat tool accomplishes for us. Ending with the output of a Seurat object which we can then further explore in RStudio.
{: .comment}


# Get Your Data
For this tutorial, we'll use a publicly available dataset of 8,617 cord blood mononuclear cells (CBMCs) which have been sequenced for transcriptomic measurements as well as 11 surface proteins ({% cite Satija&Smibert2017 %}).

><comment-title></comment-title>
>A quick note on nomenclature when working with Cite-Seq.
>Antibody derived tag (ADT) refers to the cell surface protein abundance measurements
>meanwhile RNA: represents the transcriptomic measurements
{: .comment}

First on the to-do list is importing our csv files. You can do this in a couple of ways:



## Option 1: Uploading Data via Link

> <hands-on-title></hands-on-title>
>
> 1. Create a new history for this tutorial
> 2. Import the csv files object from NCBI:

> To retrive the ADT file:
> ```
> ftp://ftp.ncbi.nlm.nih.gov/geo/series/GSE100nnn/GSE100866/suppl/GSE100866_CBMC_8K_13AB_10X-ADT_umi.csv.gz
> ```
> To retrieve the RNA file:
> ```
> ftp://ftp.ncbi.nlm.nih.gov/geo/series/GSE100nnn/GSE100866/suppl/GSE100866_CBMC_8K_13AB_10X-RNA_umi.csv.gz
> ```
> {% snippet faqs/galaxy/datasets_import_via_link.md %}
{: .hands_on}


## Option 2: Import a History
You can access [this history](https://usegalaxy.eu/u/camila-goclowski/h/citeseqseurattooltutorial) by clicking on the link provided.

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

# Cite-Seq Enabled Seurat Tool

Now we'll run those csv files through the updated Seurat tool with the following parameters:
> <hands-on-title></hands-on-title>
> Run {% tool [Seurat](toolshed.g2.bx.psu.edu/repos/iuc/seurat/seurat/4.3.0.1+galaxy1) %} with the following parameters:
> - *"Which Seuray method should be run"*: `Cite-seq`
> - *"RNA counts file"*: `1: GSE100866_CBMC_8K_13AB_10X-RNA_umi.csv.gz`
> - *"Protein counts file"*: `2: GSE100866_CBMC_8K_10X-ADT_umi.csv.gz`
> - *"Minimum cells"*: `5`
> - *"Minimum genes"*: `10`
> - *"Low threshold for filtering cells"*: `1500`
> - *"High threshold for filtering cells"*: `30000`
> - *"Include violin plot and scatter plot of cell features"*: `No`
> - *"Output seurat object after data normalization"*: `No`
> - *"Include plot of variable features"*: `No`
> - *"Output seurat object after data scaling"*: `No`
> - *"Number of PCs to use in plots"*: `15`
> - *"Include PCA plots"*: `No`
> - *"Output seurat object after PCA analysis"*: `No`
> - *"Perplexity parameter"*: ``
> - *"Resolution parameter"*: `0.8`
> - *"Include UMAP and TSNE plots"*: `Yes`
> - *"Output seurat object after TSNE and UMAP analysis"*: `No`
> - *"Minimum percent cells"*: `0.1`
> - *"Log fold change threshold"*: `0.25`
> - *"Include heatmaps of markers"*: `Yes`
> - *"Output marker data"*: `Yes`
> - *"Output list of cite-seq markers"*: `Yes`
> - *"Compare specific feature's effect on protein and rna expression?"*: `No`
> - *"Compare top RNA and protein features graphicaly against themselves and one another"*: `No`
{: .hands_on}

><comment-title></comment-title>
>Note that the parameters listed above are just one way you may use this super useful, one step tool. Feel free to play around with different parameters to see how it affects the data!
>
>If you're hoping to follow this tutorial step by step, word for word, be aware that changing any of the above parameters may change the data you get to explore shortly in RStudio.
{: .comment}

# Moving to RStudio
Now that we have some explorable data (a Seurat object) in our Galaxy history, let's move into RStudio and keep investigating:
> <hands-on-title>Open RStudio in Galaxy</hands-on-title>
> Run {% tool [RStudio](interactive_tool_rstudio)%}
{: .hands_on}

><comment-title>Next Step</comment-title>
> The interactive RStudio tool should begin to load now. Make your way over to your Active Interactive Tools page (User (in the top bar of the usegalaxy page) > Active Interactive Tools > RStudio)
> ![Interactive Tools Button](../../images/scCiteSeq-RStudio/Plot12.png "Interactive Tools")
>
>Alternatively, you can use the view (eye) icon in your Galaxy History to open the interactive RStudio environment.
> ![Eye Button](../../images/scCiteSeq-RStudio/Plot13.png "Eye Button")
{: .comment}

It may be a good time to explore some of these output files that are now in your history. Take a look at some of the previews and see if you can get a grasp of what's what. If not, no worries at all, we'll start looking more closely once we've made it into RStudio!
42 changes: 42 additions & 0 deletions topics/single-cell/tutorials/scCiteSeq-RStudio/tutorial.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# This is the bibliography file for your tutorial.
#
# To add bibliography (bibtex) entries here, follow these steps:
# 1) Find the DOI for the article you want to cite
# 2) Go to https://doi2bib.org and fill in the DOI
# 3) Copy the resulting bibtex entry into this file
#
# To cite the example below, in your tutorial.md file
# use {% cite Batut2018 %}
#
# If you want to cite an online resourse (website etc)
# you can use the 'online' format (see below)
#
# You can remove the examples below

@article{Satija2015,
doi = {10.1038/nbt.3192},
url = {https://doi.org/10.1038/nbt.3192},
year = {2015},
month = May,
publisher = {Nature Anerica Inc. All rights reserved},
volume = {33},
number = {5},
author = {Rahul Satija and Jeffrey A. Farrell and David Gennert and Alexander F Schier and Aviv Regev},
title = {Spatial reconstruction of single-cell gene expression data},
journal = {Nature Biotechnology}
}


@article{Satija&Smibert2017,
doi = {10.1038/NMETH.4380},
url = {https://doi.org/10.1038/nmeth.4380},
year = {2017},
month = {July},

publisher = {Nature America Inc.},
volume = {14},
number = {9},
author = {Marlon Stoeckius and Cristoph Hafemeister and William Stephenson and Brian Houck-Loomis and Pratip K Chattopadhyay and Harols Swerdlow and Rahul Satija and Peter Smibert},
title = {Simultaneous epitope and transcriptome measurement in single cells},
journal = {Nature Methods}
}
Loading
Loading