You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit b3eded4
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: book/back-matter/glossary.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ Directory Format
42
42
43
43
Distribution
44
44
A collection of QIIME 2 plugins that are installed together through a single {term}`conda metapackage`.
45
-
These are generally grouped by a theme. For example, the *amplicon distribution* provides a collection of plugins for analysis of microbiome amplicon data, while MOSHPIT (previously the *metagenome distribution*) provides a collection of plugins for analysis of microbiome shotgun metagenomics data.
45
+
These are generally grouped by a theme. For example, the *qiime2 distribution* provides a collection of plugins for analysis of microbiome amplicon data, while MOSHPIT (previously the *metagenome distribution*) provides a collection of plugins for analysis of microbiome shotgun metagenomics data.
46
46
When a distribution is installed, that particular installation of QIIME 2 is an example of a {term}`deployment`.
Copy file name to clipboardExpand all lines: book/plugins/how-to-guides/automate-testing.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -119,7 +119,7 @@ With the bracketed terms defined as:
119
119
-`<next-epoch>`: the next QIIME 2 release epoch.
120
120
QIIME 2 releases are scheduled for the first Wednesday of April and October, so this value is always predictable.
121
121
For example, if the most recent release was 2024.10, your `<next-epoch>` would be 2025.4.
122
-
-`<target-distribution>`: the QIIME 2 distribution that your plugin should be installed under (e.g., `amplicon` or `moshpit`).
122
+
-`<target-distribution>`: the rachis distribution that your plugin should be installed under (e.g., `qiime2` or `moshpit`).
123
123
-`<target-branch>` (optional): the branch of your repository that testing will be performed against. If not specified, this will default to your repository's *Default branch* (e.g., `main`). If you don't include this, you should leave off the `@` symbol following `.git`.
124
124
125
125
You can set up any additional GHAs on your repository that you feel will be beneficial to your plugin and general development workflow.
Copy file name to clipboardExpand all lines: book/plugins/how-to-guides/distribute-on-gh.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The GitHub command line interface is used here as it's easier to document and te
16
16
17
17
Create a new template plugin, according to the instructions in [](plugin-from-template).
18
18
Pay attention to the question about the "target distribution" - this enables templating of installation instructions and test machinery against the distribution of your choice.
19
-
For example, if you want your plugin to expand upon the `amplicon` distribution, this is where you indicate that.
19
+
For example, if you want your plugin to expand upon the `qiime2` distribution, this is where you indicate that.
20
20
21
21
After completing those steps, return to this page.
Copy file name to clipboardExpand all lines: book/plugins/how-to-guides/maximize-compatibility.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The Caporaso Lab is not taking on new responsibility for distributing plugins ri
15
15
16
16
You can consider the existing distributions to be foundations that you can build on, or you can create and distribute your own conda metapackages.
17
17
Some guidance on each of these approaches:
18
-
- Your install instructions can indicate that a user should install whichever distribution you depend on (e.g., `tiny`, `amplicon`, or `moshpit`) and then illustrate how to install your plugin(s) in that environment however it makes sense (e.g., `conda` or `pip`). Complete install instructions are drafted for you in the `README.md` of plugins that you build using our template (see [](plugin-from-template)).
18
+
- Your install instructions can indicate that a user should install whichever distribution you depend on (e.g., `tiny`, `qiime2`, `moshpit`, etc) and then illustrate how to install your plugin(s) in that environment however it makes sense (e.g., `conda` or `pip`). Complete install instructions are drafted for you in the `README.md` of plugins that you build using our template (see [](plugin-from-template)).
19
19
- Alternatively, you can compose and share your own distribution of plugins (e.g., building from the `tiny` distribution) that captures the set of functionality you’d like to share.
20
20
21
21
Either of these approaches is totally fine, with the following caveats.
@@ -29,4 +29,4 @@ With the above information in mind, refer to [](facilitating-installation) for i
29
29
You can request feedback on your plugin as a whole from more experienced QIIME 2 developers by reaching out through the {{ developer_discussion }}.
30
30
However, be cognizant of the fact that doing code review takes a long time to do well: you should only request this when you feel like you have a final draft of the plugin that you'd like to release, and expect that the reviewer may point out that there is a bunch more work that should be done before you release.
31
31
Please have others who you work closely with -- ideally experienced software developers, and even more ideally experienced QIIME 2 plugin developers -- review it first.
32
-
If you have questions along the way, you can ask those whenever - just be sure to review *[Developing with QIIME 2](https://develop.qiime2.org/)* and search the forum in case your question has already been answered previously.
32
+
If you have questions along the way, you can ask those whenever - just be sure to review *[Developing with QIIME 2](https://develop.qiime2.org/)* and search the forum in case your question has already been answered previously.
Copy file name to clipboardExpand all lines: book/plugins/how-to-guides/use-metadata.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ All types of data columns can be instantiated as `CategoricalMetadataColumn` - v
74
74
75
75
## How can the Metadata API Help Me?
76
76
77
-
The `qiime2.metadata.Metadata`API has many interesting features - here are some of the more commonly utlitized elements amongst the plugins within the Amplicon {term}`Distribution`.
77
+
The `qiime2.metadata.Metadata`API has many interesting features - here are some of the more commonly utlitized elements amongst the plugins within the qiime2 {term}`Distribution`.
78
78
79
79
### Merging Metadata
80
80
@@ -124,4 +124,3 @@ This will generate an artifact containing the metadata that your function provid
124
124
`ImmutableMetadata` artifacts can be [viewed as`Metadata`](artifacts-as-metadata), so they can be used anywhere that a typical metadata `.tsv`file can be provided asinputinQIIME2.
125
125
This includes q2-metadata's `tabulate` visualizer.
126
126
Additionally, if you want to obtain a `.tsv`file representation of an `ImmutableMetadata` artifact, you can [export it](https://docs.qiime2.org/2024.2/tutorials/exporting/).
Copy file name to clipboardExpand all lines: book/plugins/references/patterns.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ When you're naming inputs, outputs, and parameters for your actions, look at oth
11
11
12
12
### Metadata parameter name recommendations
13
13
14
-
We make the following recommendations for naming `Metadata` parameters, based on [a review](https://gist.github.com/gregcaporaso/4be64940f80256316e3308d2ae2ec0da) of how these had actually been named in the plugins in the QIIME 2 *amplicon distribution* in November 2025.
14
+
We make the following recommendations for naming `Metadata` parameters, based on [a review](https://gist.github.com/gregcaporaso/4be64940f80256316e3308d2ae2ec0da) of how these had actually been named in the plugins in the rachis *qiime2 distribution* in November 2025.
15
15
16
16
- If your action takes only one sample metadata input, call it `metadata`. ([example: `kmer-diversity`](https://amplicon-docs.qiime2.org/en/latest/references/plugins/boots.html#q2-action-boots-kmer-diversity))
17
17
- If your action takes only one feature metadata input, call it `feature-metadata`.
0 commit comments