owmeta.document module¶
-
class
owmeta.document.
Document
(bibtex=None, doi=None, pubmed=None, wormbase=None, **kwargs)[source]¶ Bases:
owmeta.document.BaseDocument
A representation of some document.
Possible keys include:
pmid, pubmed: a pubmed id or url (e.g., 24098140) wbid, wormbase: a wormbase id or url (e.g., WBPaper00044287) doi: a Digitial Object id or url (e.g., s00454-010-9273-0) uri: a URI specific to the document, preferably usable for accessing the document
Parameters: - bibtex :
str
A string containing a single BibTeX entry. Parsed during initialization, but not saved thereafter. optional
- doi :
str
A Digital Object Identifier (DOI). optional
- pubmed :
str
A PubMed ID (PMID) or URL that points to a paper. Ignored if ‘pmid’ is provided. optional
- wormbase :
str
An ID or URL from WormBase that points to a record. Ignored if
wbid
orwormbaseid
are provided. optional
-
defined_augment
()[source]¶ This fuction must return False if
identifier_augment()
would raise anIdentifierMissingException
. Override it when defining a non-standard identifier for subclasses of DataObjects.
-
identifier_augment
()[source]¶ Override this method to define an identifier in lieu of one explicity set.
One must also override
defined_augment()
to return True whenever this method could return a valid identifier.IdentifierMissingException
should be raised if an identifier cannot be generated by this method.Raises: IdentifierMissingException
-
update_from_wormbase
(replace_existing=False)[source]¶ Queries wormbase for additional data to fill in the Document.
If replace_existing is set to
True
, then existing values will be cleared.
An author of the document
-
date
¶ Alias to year
-
doi
¶ A Digital Object Identifier (DOI), optional
-
pmid
¶ A PubMed ID (PMID) that points to a paper
-
title
¶ The title of the document
-
uri
¶ A non-standard URI for the document
-
wbid
¶ An ID from WormBase.org that points to a record, optional
-
year
¶ The year (e.g., publication year) of the document
- bibtex :