How-To Guides

This chapter of the documentation provides instructions for achieving specific goals with your plugin.

Note

If you’ve never built a QIIME 2 plugin before, and would like step-by-step instructions for building an example plugin before creating your own, you’ll find those instructions in the tutorial on building your first QIIME 2 plugin. If you’re already comfortable with plugin development and are looking for instructions to achieve a specific task, you may find more targeted instructions in the Plugin Development 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