random content

qiime2 · Oct 31, 2024 · 5becf63 · 5becf63
1 parent 78cfe3e
commit 5becf63
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -8,5 +8,3 @@ To learn more about installing and using q2-fmt, refer to the [q2-fmt documentat
 ## Demo
 [![](https://raw.githubusercontent.com/qiime2/q2-fmt/master/demo/screenshot.png)
 **Interactive Link**](https://view.qiime2.org/visualization/?type=html&src=https%3A%2F%2Fraw.githubusercontent.com%2Fqiime2%2Fq2-fmt%2Fmaster%2Fdemo%2Fraincloud-baseline0.qzv)
-
-```
diff --git a/book/q2_fmt_book/explanation/placeholder.md b/book/q2_fmt_book/explanation/placeholder.md
@@ -1,5 +1,5 @@
 # Explanations
 
-This section of the tutorial is currently under development! 🧰 
+This section of the q2-fmt docs is currently under 🛠️ development 🧰! 
 
-Check back soon for more information! 
+Check back soon for more information on explanations of the methods in q2-fmt! 
diff --git a/book/q2_fmt_book/how-to-guides/installation.md b/book/q2_fmt_book/how-to-guides/installation.md
@@ -1,6 +1,10 @@
-## Installation
+# Installation
+
+Please note that this software is now an *alpha release* and interfaces are subject to change. 
+For now, create a fresh  `Development` conda environment for q2-fmt using the following command: 
+
+These installation installs will have the classic qiime2 amplicon env and q2-fmt.
 
-Please note that this software is now an *alpha release*. Initial conda packages are available, but have not been tested in integration against our other plugins yet. For now, create a fresh  `Development` conda environment for q2-fmt using the following command: 
 
 Mac OS instructions 
 ```bash
@@ -21,3 +25,13 @@ Then activate your new environment as usual.
 conda activate q2-fmt-2024.10
 ```
 
+## Updating an existing env to have q2-fmt 
+
+If you have an existing qiime2 env that you want to install q2-fmt in, please run the following command: 
+```bash 
+conda activate <env-name> # conda env you wish to install this plugin into
+
+conda env update --file https://raw.githubusercontent.com/qiime2/q2-fmt/dev/environment-files/2024.10-q2-fmt-environment.yml
+```
+
+Awesome! Now, you are ready to start assessing engraftment extent with q2-fmt!
diff --git a/book/q2_fmt_book/intro.md b/book/q2_fmt_book/intro.md
@@ -1,12 +1,19 @@
 # QIIME 2 FMT Book
 
-This tutorial was orignally made for the 2024 [ITN](https://www.itcrtraining.org/) / [QIIME 2](https://qiime2.org) Workshop, taught 27 - 29 August 2024 at the National Institutes of Health. If you are interested in the original workshop tutorial, please visit: https://q2-cat-book.readthedocs.io/en/2024.08.27-q2-itn/. This tutorial is now the offical documentation for the q2-fmt plugin.
+This tutorial was orignally made for the 2024 [ITN](https://www.itcrtraining.org/) / [QIIME 2](https://qiime2.org) Workshop, taught 27 - 29 August 2024 at the National Institutes of Health. 
+If you are interested in the original workshop tutorial, please visit: https://q2-cat-book.readthedocs.io/en/2024.08.27-q2-itn/. 
+This tutorial is now the offical documentation for the q2-fmt plugin.
 
 ```{admonition} Code of Conduct
 Please review the [QIIME 2 Community Code of Conduct](https://forum.qiime2.org/t/qiime-2-community-code-of-conduct/9057).
 All workshop instructors agreed to abide by these community expectations and we hope you will too as you become involved in the QIIME 2 community.
 ```
 
+This tutorial will walk you through all the functionality available in q2-fmt. 
+We will start with a metadata file and feature table. 
+We will discuss choosing an even sampling depth and generating diversity metrics so that we are prepared to run our data through q2-fmt.
+Grab a cup of coffee or tea ☕, and lets jump right in!
+
 ## Recommended readings
 
 The following readings will provide background information for this tutorial.
@@ -22,18 +29,20 @@ These are presented in priority order.
 
 ## Thank you to our funders
 
-This workshop was funded in part by NIH National Cancer Institute Informatics Technology for Cancer Research grant [1U24CA248454-01](https://reporter.nih.gov/project-details/9951750) to JGC and UE5CA254170 to the ITCR Training Network.
+This tutorial  was funded in part by NIH National Cancer Institute Informatics Technology for Cancer Research grant [1U24CA248454-01](https://reporter.nih.gov/project-details/9951750) to JGC.
 
 The preparation and dissemination of the data used in this tutorial was funded in part by the National Institutes of Health (NIH) grants U01 AI124275, R01 AI137269 and U54 CA209975 to Joao B. Xavier.
 
 This website is built with MyST Markdown and Jupyter Book, which are supported in part with [funding](https://sloan.org/grant-detail/6620) from the Alfred P. Sloan Foundation.
 
 ## Reusing
 
- <p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://q2-cat-book.readthedocs.io/en/latest/#">q2-cat-book</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://cap-lab.bio">Caporaso Lab</a> is licensed under <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY-NC-SA 4.0.<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt=""></a></p>
+ <p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://q2-fmt.readthedocs.io/en/latest/intro.html">q2-fmt-book</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://cap-lab.bio">Caporaso Lab</a> is licensed under <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY-NC-SA 4.0.<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt=""></a></p>
 
  You are free distribute, remix, adapt, and build upon the material in any medium or format, for noncommercial purposes only, as long as credit is given to the original creator. Adaptations must be shared under the same terms.
 
 
+## Table of Contents
+
 ```{tableofcontents}
 ```
diff --git a/book/q2_fmt_book/reference/reference.md b/book/q2_fmt_book/reference/reference.md
@@ -2,18 +2,24 @@
 
 ## q2-fmt Help Text
 
+This section of the tutorial is currently under 🛠️ development 🧰! 
 We are currently working on auto generating help text and examples associated with q2-fmt.
-For now the best way to get information about which commands are available in q2-fmt is to run `qiime2 fmt --help`.
-For more information on each command run `qiime2 fmt {command-name} --help`
 
 
+For now the best way to get information about which commands are available in q2-fmt is to run: 
+```bash
+qiime2 fmt --help
+```
+
+For more information on each command run:
+```bash
+qiime2 fmt {command-name} --help
+```
+
 ## Examples
-Example data can be generated using the `--example-data` flag on each action
-described below. This will create a directory structure to match the examples
-(you will need to `cd` into the appropriate directory first).
+Example data can be generated using the `--example-data` flag on each action described below.
 
 ```bash
 qiime fmt --example-data fmt-examples/
-cd fmt-examples/cc/cc-baseline/
 ```
 
diff --git a/book/q2_fmt_book/tutorial/tutorial.md b/book/q2_fmt_book/tutorial/tutorial.md
@@ -412,7 +412,7 @@ Currently, we do this by running ANCOMBC comparing the recipient at baseline to
 
 However, some people investigate microbes that other papers reported as imported. We will investigate if the feature was in the donated microbiome and if the recipient recieved the feature. 
 
-(This review)[https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8436969/] reported that the class of *Clostridia* is correlated with positive health outcomes. 
+[This review](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8436969/) reported that the class of *Clostridia* is correlated with positive health outcomes. 
 
 So here we are going to use q2-longitudinal to track the relative abunadnce of *Clostridia* over time. This will help us identify if the donated microbiome had the previously reported feature and if the recipients recieve this feature.
 

diff --git a/book/q2_fmt_book/works-cited.md b/book/q2_fmt_book/works-cited.md
@@ -1,4 +1,4 @@
-# Works cited
+# Works Cited
 
 ```{bibliography}
 ```