Plugin Definition and Registration

class qiime2.plugin.Citations
classmethod load(path, package=None)
save(f)
class qiime2.plugin.CitationRecord(type, fields)
count(value, /)

Return number of occurrences of value.

fields

Alias for field number 1

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

type

Alias for field number 0

class qiime2.plugin.Plugin(name, version, website, package=None, project_name=None, citation_text=None, user_support_text=None, short_description=None, description=None, citations=None)
property actions
freeze()
register_formats(*formats, citations=None)
register_semantic_type_to_format(semantic_type, artifact_format)
register_semantic_types(*type_fragments)
register_transformer(_fn=None, *, citations=None)

A transformer has the type Callable[[type], type]

register_validator(semantic_expression)
register_views(*views, citations=None)
property types

Record Containers

qiime2.plugin.plugin.TransformerRecord = <class 'qiime2.plugin.plugin.TransformerRecord'>

TransformerRecord(transformer, plugin, citations)

qiime2.plugin.plugin.SemanticTypeRecord = <class 'qiime2.plugin.plugin.SemanticTypeRecord'>

SemanticTypeRecord(semantic_type, plugin)

qiime2.plugin.plugin.FormatRecord = <class 'qiime2.plugin.plugin.FormatRecord'>

FormatRecord(format, plugin)

qiime2.plugin.plugin.ViewRecord = <class 'qiime2.plugin.plugin.ViewRecord'>

ViewRecord(name, view, plugin, citations)

qiime2.plugin.plugin.TypeFormatRecord = <class 'qiime2.plugin.plugin.TypeFormatRecord'>

TypeFormatRecord(type_expression, format, plugin)

Formats

class qiime2.plugin.model.BinaryFileFormat(path=None, mode='w')
open()
save(path, ext=None)
validate(level='max')
view(view_type)
class qiime2.plugin.model.DirectoryFormat(path=None, mode='w')
save(path, ext=None)
validate(level='max')
class qiime2.plugin.model.File(pathspec, *, format=None)
class qiime2.plugin.model.FileCollection(pathspec, *, format=None)
set_path_maker(function)
qiime2.plugin.model.SingleFileDirectoryFormat(name, pathspec, format)
class qiime2.plugin.model.SingleFileDirectoryFormatBase(path=None, mode='w')
save(path, ext=None)
validate(level='max')
class qiime2.plugin.model.TextFileFormat(path=None, mode='w')
open()
save(path, ext=None)
validate(level='max')
view(view_type)