Merge pull request #68 from ahernank/af-pre-release-fix

Add note on flag meaning to access pre-release data
malariagen · Jun 17, 2024 · 4a362f3 · 4a362f3
2 parents e141652 + d0ed4fb
commit 4a362f3
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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)"
    ]
   },
   {