Deployed e7f7326 with MkDocs version: 1.5.3

MR-Biomarker-Resource · Dec 11, 2023 · 857fc87 · 857fc87
1 parent d0ae3a9
commit 857fc87
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 5 deletions.
diff --git a/404.html b/404.html
@@ -102,6 +102,10 @@ <h1 id="404-page-not-found">404</h1>
   <div class="rst-versions" role="note" aria-label="Versions">
   <span class="rst-current-version" data-toggle="rst-current-version">
 
+        <span>
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+        </span>
+
 
 
   </span>

diff --git a/about/index.html b/about/index.html
@@ -75,6 +75,7 @@
     <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
       <li class="breadcrumb-item active">About</li>
     <li class="wy-breadcrumbs-aside">
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy/edit/master/docs/about.md" class="icon icon-github"> Edit on GitHub</a>
     </li>
   </ul>
   <hr/>
@@ -109,6 +110,10 @@
   <div class="rst-versions" role="note" aria-label="Versions">
   <span class="rst-current-version" data-toggle="rst-current-version">
 
+        <span>
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+        </span>
+
 
       <span><a href="../methods/" style="color: #fcfcfc">&laquo; Previous</a></span>
 

diff --git a/getting_started/index.html b/getting_started/index.html
@@ -79,6 +79,7 @@
     <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
       <li class="breadcrumb-item active">Getting Started</li>
     <li class="wy-breadcrumbs-aside">
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy/edit/master/docs/getting_started.md" class="icon icon-github"> Edit on GitHub</a>
     </li>
   </ul>
   <hr/>
@@ -119,6 +120,10 @@ <h2 id="installation">Installation</h2>
   <div class="rst-versions" role="note" aria-label="Versions">
   <span class="rst-current-version" data-toggle="rst-current-version">
 
+        <span>
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+        </span>
+
 
       <span><a href=".." style="color: #fcfcfc">&laquo; Previous</a></span>
 

diff --git a/index.html b/index.html
@@ -77,6 +77,7 @@
     <li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
       <li class="breadcrumb-item active">Home</li>
     <li class="wy-breadcrumbs-aside">
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy/edit/master/docs/index.md" class="icon icon-github"> Edit on GitHub</a>
     </li>
   </ul>
   <hr/>
@@ -114,6 +115,10 @@ <h1 id="mricloudpy-documentation">MRICloudPy Documentation</h1>
   <div class="rst-versions" role="note" aria-label="Versions">
   <span class="rst-current-version" data-toggle="rst-current-version">
 
+        <span>
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+        </span>
+
 
 
       <span><a href="getting_started/" style="color: #fcfcfc">Next &raquo;</a></span>
@@ -136,5 +141,5 @@ <h1 id="mricloudpy-documentation">MRICloudPy Documentation</h1>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2023-12-03 22:16:40.527002+00:00
+Build Date UTC : 2023-12-11 21:18:52.068554+00:00
 -->
diff --git a/methods/index.html b/methods/index.html
@@ -129,6 +129,7 @@
     <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
       <li class="breadcrumb-item active">Methods</li>
     <li class="wy-breadcrumbs-aside">
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy/edit/master/docs/methods.md" class="icon icon-github"> Edit on GitHub</a>
     </li>
   </ul>
   <hr/>
@@ -307,16 +308,17 @@ <h3 id="logit">Logit</h3>
 </ul>
 <hr />
 <h2 id="imaging">Imaging</h2>
+<p>Generates a subplot or single image (if 'nrows' and 'ncols' is 1) of region-specific brain images on a template brain</p>
 <h3 id="generate_3d_image">generate_3d_image</h3>
 <pre><code class="language-python">generate_3d_image(img_path, regions, view, nrows, ncols, slice_n=0)
 </code></pre>
 <p><strong>Parameters:</strong></p>
 <ul>
 <li><strong>img_path</strong>: <em>str</em></li>
 <li><strong>regions</strong>: <em>list</em></li>
-<li><strong>view</strong>: <em>int</em></li>
-<li><strong>nrows</strong>: <em>int</em></li>
-<li><strong>ncols</strong>: <em>int</em></li>
+<li><strong>view</strong>: <em>int, {0 (horizontal), 1 (sagittal), 2 (coronal)}</em></li>
+<li><strong>nrows</strong>: <em>int, {1, 2, 3, 4, 5, 6, 7}</em></li>
+<li><strong>ncols</strong>: <em>int, {1, 2, 3, 4, 5, 6, 7}</em></li>
 <li><strong>slice_n</strong>: <em>int, default = 0</em></li>
 </ul>
 
@@ -346,6 +348,10 @@ <h3 id="generate_3d_image">generate_3d_image</h3>
   <div class="rst-versions" role="note" aria-label="Versions">
   <span class="rst-current-version" data-toggle="rst-current-version">
 
+        <span>
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+        </span>
+
 
       <span><a href="../user_guide/" style="color: #fcfcfc">&laquo; Previous</a></span>
 

diff --git a/search.html b/search.html
@@ -109,6 +109,10 @@ <h1 id="search">Search Results</h1>
   <div class="rst-versions" role="note" aria-label="Versions">
   <span class="rst-current-version" data-toggle="rst-current-version">
 
+        <span>
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+        </span>
+
 
 
   </span>

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/user_guide/index.html b/user_guide/index.html
@@ -99,6 +99,7 @@
     <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
       <li class="breadcrumb-item active">User Guide</li>
     <li class="wy-breadcrumbs-aside">
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy/edit/master/docs/user_guide.md" class="icon icon-github"> Edit on GitHub</a>
     </li>
   </ul>
   <hr/>
@@ -215,6 +216,10 @@ <h3 id="running-ols-regression">Running OLS regression</h3>
   <div class="rst-versions" role="note" aria-label="Versions">
   <span class="rst-current-version" data-toggle="rst-current-version">
 
+        <span>
+          <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+        </span>
+
 
       <span><a href="../getting_started/" style="color: #fcfcfc">&laquo; Previous</a></span>
-Original file line number
+Diff line change
@@ Expand Up / @@ -102,6 +102,10 @@ <h1 id="404-page-not-found">404</h1> @@
       <div class="rst-versions" role="note" aria-label="Versions">
       <span class="rst-current-version" data-toggle="rst-current-version">
+            <span>
+              <a href="https://github.com/MR-Biomarker-Resource/mricloudpy" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
+            </span>
       </span>
@@ Expand Down @@