Controlled Vocabulary Interface¶

This module provides a limited interface to the HUPO PSI-MS controlled vocabulary through the psims module. This module is used heavily internally to generate static data lists.

Represent controlled vocabulary (CV) terms and provides the machinery used for building compile-time collections of CV terms from the PSI-MS controlled vocabulary.

class ms_deisotope.data_source.metadata.cv.Term(name, id, description, category, specialization)[source]¶

Represents a single controlled vocabulary term.

Term objects are comparable and hashable.

name¶

The human-readable name for the term

Type

str

id¶

A namespace-qualified unique alphanumeric identifier for the term

Type

str

description¶

A longer description of the concept the term represents.

Type

str

category¶

The name of the broad class of terms this term belongs to

Type

str

specialization¶

A sequence of increasingly specific categories that this term belongs to

Type

list

is_a(term)[source]¶

Test whether this entity is exactly term or a specialization of term

Parameters

term (str or Term) – The entity to compare to

Returns

Return type

bool

ms_deisotope.data_source.metadata.cv.cv_psims¶

A lazily loaded mapping over the PSI-MS controlled vocabulary. It may be queried using names, aliases, or accession numbers, and the term graph may be traversed.