Skip to main content
Back to top
Ctrl
+
K
Search
Ctrl
+
K
Plugins 🔌
Plugin Development
Tutorial: A step-by-step guide to building your first QIIME 2 plugin
Create your plugin from a template
Add a first (real) Method
Add a first Visualizer
Add a new Artifact Class
Add a Usage Example
Add a second transformer
Add a first Pipeline
Add a Pipeline with parallel computing support
Integrate metadata in Actions
Conclusion
How-To Guides
Set up your development environment
Distribute plugins on GitHub
Provide technical support for your users
Maximize compatibility between your plugin(s) and existing QIIME 2 distribution(s)
Facilitating installation of your plugin for users
Automate testing of your plugin
Publicize your QIIME 2 plugins (or other QIIME 2-based tools)
Register a QIIME 2 plugin
Create and register a Method
Create and register a visualizer
Create and register a pipeline
Creating and registering a Transformer
Use Artifact Collections as Action inputs or outputs
How to play nicely with other plugins
How to use Metadata
How to test QIIME 2 plugins
Writing Usage Examples
Defining different Format validation levels
Handling exceptions in parallel Pipelines
Explanations
Types of QIIME 2 Actions
The structure of QIIME 2 plugin packages
Semantic types, data types, file formats, and artifact classes
Transformers
References
Plugin development anti-patterns
Plugin Development API
Plugin & Registration
Formats
Types
Citations
Testing
Utilities
Pipeline Context Object
Usage Examples
User Metadata API
Interfaces 🧩
Interface Development
References
Interface developer API reference
The Framework 🌳
Framework Development
Explanations
QIIME 2 architecture overview
How Data is Stored
Anatomy of an Archive
Semantic Types, Primitives, and Visualizations
File Formats and Directory Formats
Decentralized retrospective provenance tracking
Garbage Collection
Metaprogramming
References
Archive versions
Documentation 📚
Docs Development
User documentation
Developer documentation
Continuous Integration 🛠️
Distribution Development
Back Matter 🗂️
Back matter
Glossary
List of works cited
Index
.md
.pdf
Back matter
Back matter
#
Glossary
List of works cited
Index
