From d0ed4fb8f250d722b0e990978b102784098979f8 Mon Sep 17 00:00:00 2001 From: ahernank Date: Mon, 17 Jun 2024 07:25:53 -0500 Subject: [PATCH] add flag note --- docs/af1/af1.1.ipynb | 11 ++++++++++- docs/af1/af1.2.ipynb | 11 ++++++++++- docs/af1/af1.3.ipynb | 11 ++++++++++- 3 files changed, 30 insertions(+), 3 deletions(-) diff --git a/docs/af1/af1.1.ipynb b/docs/af1/af1.1.ipynb index 74b1107..3755ab2 100644 --- a/docs/af1/af1.1.ipynb +++ b/docs/af1/af1.1.ipynb @@ -115,6 +115,15 @@ "%pip install -qq malariagen_data" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "**Note:** To access the `Af1.1` release, you need to use the `pre=True` flag as shown in the line below. \n", + "\n", + "This flag is used when more data will be added to this release, for the case of `Af1.1`, CNV data for the sample sets on this release will be included at a future date." + ] + }, { "cell_type": "code", "execution_count": 3, @@ -418,7 +427,7 @@ ], "source": [ "import malariagen_data\n", - "af1 = malariagen_data.Af1()" + "af1 = malariagen_data.Af1(pre=True)" ] }, { diff --git a/docs/af1/af1.2.ipynb b/docs/af1/af1.2.ipynb index 5030756..dcf4443 100644 --- a/docs/af1/af1.2.ipynb +++ b/docs/af1/af1.2.ipynb @@ -104,6 +104,15 @@ "%pip install -qq malariagen_data" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "**Note:** To access the `Af1.2` release, you need to use the `pre=True` flag as shown in the line below. \n", + "\n", + "This flag is used when more data will be added to this release, for the case of `Af1.2`, CNV data for the sample sets on this release will be included at a future date." + ] + }, { "cell_type": "code", "execution_count": 1, @@ -436,7 +445,7 @@ ], "source": [ "import malariagen_data\n", - "af1 = malariagen_data.Af1()" + "af1 = malariagen_data.Af1(pre=True)" ] }, { diff --git a/docs/af1/af1.3.ipynb b/docs/af1/af1.3.ipynb index 185ac62..9201dfd 100644 --- a/docs/af1/af1.3.ipynb +++ b/docs/af1/af1.3.ipynb @@ -100,6 +100,15 @@ "%pip install -qq malariagen_data" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "**Note:** To access the `Af1.3` release, you need to use the `pre=True` flag as shown in the line below. \n", + "\n", + "This flag is used when more data will be added to this release, for the case of `Af1.3`, CNV data for the sample sets on this release will be included at a future date." + ] + }, { "cell_type": "code", "execution_count": 1, @@ -432,7 +441,7 @@ ], "source": [ "import malariagen_data\n", - "af1 = malariagen_data.Af1()" + "af1 = malariagen_data.Af1(pre=True)" ] }, {