From f51b033beaa3d8d433591dbefd0db835a6aee29d Mon Sep 17 00:00:00 2001 From: Dorota Jarecka Date: Wed, 20 Sep 2023 16:00:54 -0400 Subject: [PATCH] adding comments about the data download and notebooks execution --- notebooks/10x_snRNASeq_tutorial_part_1.ipynb | 18 ++++++------------ notebooks/10x_snRNASeq_tutorial_part_2a.ipynb | 12 +++++------- notebooks/10x_snRNASeq_tutorial_part_2b.ipynb | 10 ++++------ notebooks/getting_started.ipynb | 8 +++++--- 4 files changed, 20 insertions(+), 28 deletions(-) diff --git a/notebooks/10x_snRNASeq_tutorial_part_1.ipynb b/notebooks/10x_snRNASeq_tutorial_part_1.ipynb index 4bd2c87..443255b 100644 --- a/notebooks/10x_snRNASeq_tutorial_part_1.ipynb +++ b/notebooks/10x_snRNASeq_tutorial_part_1.ipynb @@ -10,7 +10,7 @@ "\n", "The purpose of this set of notebooks is to provide an overview of the data, the file organization and how to combine data and metadata through example use cases.\n", "\n", - "You need to be connected to the internet to run this notebook and that you have downloaded the example data via the getting started notebook." + "**You need to be connected to the internet to run this notebook and that you have downloaded the example data via the getting started notebook.**" ] }, { @@ -1283,9 +1283,7 @@ { "cell_type": "code", "execution_count": 20, - "metadata": { - "scrolled": false - }, + "metadata": {}, "outputs": [ { "data": { @@ -2013,9 +2011,7 @@ { "cell_type": "code", "execution_count": 34, - "metadata": { - "scrolled": false - }, + "metadata": {}, "outputs": [], "source": [ "def plot_heatmap( df, fig_width = 8, fig_height = 4, cmap=plt.cm.magma_r, vmax=None) :\n", @@ -2047,9 +2043,7 @@ { "cell_type": "code", "execution_count": 35, - "metadata": { - "scrolled": false - }, + "metadata": {}, "outputs": [ { "data": { @@ -2243,7 +2237,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, @@ -2257,7 +2251,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.5" + "version": "3.10.9" } }, "nbformat": 4, diff --git a/notebooks/10x_snRNASeq_tutorial_part_2a.ipynb b/notebooks/10x_snRNASeq_tutorial_part_2a.ipynb index 161dff6..d17262a 100644 --- a/notebooks/10x_snRNASeq_tutorial_part_2a.ipynb +++ b/notebooks/10x_snRNASeq_tutorial_part_2a.ipynb @@ -8,7 +8,7 @@ "\n", "In part 1, we explore two examples looking at the expression of canonical neurotransmitter transporter genes and gene Tac2 in the thalamus. In this notebook, we will prepare data so that we can repeat the examples for all cells spanning the whole brain. This notebook takes ~ 5 minutes to run.\n", "\n", - "The results from this notebook has already been cached and saved. As such, you can skip this notebook and continue with part 2b.\n", + "**The results from this notebook has already been cached and saved. Some of the cells might raise an error if you have not downloaded all of the data. As such, you can skip this notebook and continue with part 2b.**\n", "\n", "You need to be connected to the internet to run this notebook and that you have downloaded the all the log2 expression matrices associated with both the WMB-10Xv2, WMB-10Xv3 and WMB-10XMulti datasets." ] @@ -75,9 +75,7 @@ { "cell_type": "code", "execution_count": 4, - "metadata": { - "scrolled": false - }, + "metadata": {}, "outputs": [], "source": [ "rpath = metadata['cell_metadata']['files']['csv']['relative_path']\n", @@ -284,7 +282,7 @@ "\n", "In this section, we explore two use cases. The first example looks at the expression of nine canonical neurotransmitter transporter genes and the second the expression of gene Tac2.\n", "\n", - "To support these use cases, we will create a smaller submatrix (all cells and 10 genes) and write to file for resue in part 2b. *Note this operation takes around 5 minutes*." + "To support these use cases, we will create a smaller submatrix (all cells and 10 genes) and write to file for resue in part 2b. **Note this operation takes around 5 minutes and you might need to download more data. You can always skip this part and continue with part 2b.**" ] }, { @@ -585,7 +583,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, @@ -599,7 +597,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.5" + "version": "3.10.9" } }, "nbformat": 4, diff --git a/notebooks/10x_snRNASeq_tutorial_part_2b.ipynb b/notebooks/10x_snRNASeq_tutorial_part_2b.ipynb index 45f2fc6..1256e4c 100644 --- a/notebooks/10x_snRNASeq_tutorial_part_2b.ipynb +++ b/notebooks/10x_snRNASeq_tutorial_part_2b.ipynb @@ -8,7 +8,7 @@ "\n", "We can continue to explore our examples looking at the expression of canonical neurotransmitter transporter genes and gene Tac2 over the whole brain. \n", "\n", - "You need to be connected to the internet to run this notebook and that you have downloaded the example data via the getting started notebook." + "**You need to be connected to the internet to run this notebook and that you have downloaded the example data via the getting started notebook.**" ] }, { @@ -523,9 +523,7 @@ { "cell_type": "code", "execution_count": 22, - "metadata": { - "scrolled": false - }, + "metadata": {}, "outputs": [ { "data": { @@ -625,7 +623,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, @@ -639,7 +637,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.5" + "version": "3.10.9" } }, "nbformat": 4, diff --git a/notebooks/getting_started.ipynb b/notebooks/getting_started.ipynb index ad3f9e3..bdea5ae 100644 --- a/notebooks/getting_started.ipynb +++ b/notebooks/getting_started.ipynb @@ -226,7 +226,9 @@ "source": [ "### Downloading all metadata directories\n", "\n", - "Since the metadata directories are relatively small we will download all the metadata directories. We loop through the manifest and download each metadata directory using **[AWS CLI](https://aws.amazon.com/cli/)** sync command. This should take < 5 minutes." + "Since the metadata directories are relatively small we will download all the metadata directories. We loop through the manifest and download each metadata directory using **[AWS CLI](https://aws.amazon.com/cli/)** sync command. This should take < 5 minutes.\n", + "\n", + "**Please note that there are lines that you should uncomment to run the command to download the data.**" ] }, { @@ -468,7 +470,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, @@ -482,7 +484,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.5" + "version": "3.10.9" } }, "nbformat": 4,