ControlledVocabulary#

class biopax-explorer.biopax.controlledvocabulary.ControlledVocabulary(*args, **kwargs)[source]#

Bases: UtilityClass

Class ControlledVocabulary

Definition: This class represents a term from an external controlled vocabulary

(CV). Rationale: Controlled Vocabularies mark cases where BioPAX delegates the representation of a complex biological phenomena to an external controlled vocabulary development effort such as Gene Ontology. Each subclass of this class represents one such case and often has an associated “Best-Practice” external resource to use. See the documentation of each subclass for more specific information. Correct usage of controlled vocabularies are critical to data exchange and integration. Usage: The individuals belonging to this class must unambiguously refer to the source controlled vocabulary. This can be achieved in two manners: The xref property of this class is restricted to the unification xref class. It must point to the source controlled vocabulary. Alternatively the rdf-id of the member individuals can be set to the designated MIRIAM URN. It is a best practice to do both whenever possible. Although it is possible to use multiple unification xrefs to identify semantically identical terms across alternative controlled vocabularies, this is not a recommended practice as it might lead to maintenance issues as the controlled vocabularies change. There is no recommended use-case for directly instantiating this class. Please use its subclasses instead.

code generator : rdfobj (author F.Moreews 2023-2024).

Methods

get_comment()

Attribute _comment getter

get_term()

Attribute _term getter

get_xref()

Attribute _xref getter

attribute_type_by_name

get_uri_string

object_attributes

set_comment

set_term

set_uri_string

set_xref

to_json

type_attributes

Methods Summary

attribute_type_by_name()

get_term()

Attribute _term getter

get_uri_string()

get_xref()

Attribute _xref getter

object_attributes()

set_term(value)

set_uri_string(uristr)

set_xref(value)

to_json()

type_attributes()

Methods Documentation

attribute_type_by_name()[source]#
get_term()[source]#
Attribute _term getter

The external controlled vocabulary term.

get_uri_string()[source]#
get_xref()[source]#
Attribute _xref getter

Values of this property define external cross-references from this entity to

entities in external databases.

object_attributes()[source]#
set_term(value)[source]#
set_uri_string(uristr)[source]#
set_xref(value)[source]#
to_json()[source]#
type_attributes()[source]#