aoptk.literature.metadata

Classes

Metadata

Data structure representing a publication.

Module Contents

class aoptk.literature.metadata.Metadata[source]

Data structure representing a publication.

id[source]

Identifier by which the publication was found. Can be PMID, PMCID, DOI, or other such as PPR.

Type:

ID

pmcid[source]

PubMed Central ID, if available.

Type:

PMCID | None

pmid[source]

PubMed ID, if available.

Type:

PMID | None

doi[source]

Digital Object Identifier, if available.

Type:

DOI | None

year[source]

Year of publication.

Type:

str | None

title[source]

Title of the publication.

Type:

str | None

authors[source]

Authors of the publication.

Type:

list[str] | None

id: aoptk.literature.id.ID[source]
pmcid: aoptk.literature.id.PMCID | None = None[source]
pmid: aoptk.literature.id.PMID | None = None[source]
doi: aoptk.literature.id.DOI | None = None[source]
year: int | None = None[source]
title: str | None = None[source]
authors: list[str] | None = None[source]
__str__() → aoptk.literature.id.ID[source]
__eq__(other: object) → bool[source]

Compare Metadata by their identifiers.

__hash__() → int[source]

Hash based on the identifier used by __eq__ for use in sets/dicts.