aoptk.literature.metadata
=========================

.. py:module:: aoptk.literature.metadata


Classes
-------

.. autoapisummary::

   aoptk.literature.metadata.Metadata


Module Contents
---------------

.. py:class:: Metadata

   Data structure representing a publication.

   .. attribute:: id

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

      :type: ID

   .. attribute:: pmcid

      PubMed Central ID, if available.

      :type: PMCID | None

   .. attribute:: pmid

      PubMed ID, if available.

      :type: PMID | None

   .. attribute:: doi

      Digital Object Identifier, if available.

      :type: DOI | None

   .. attribute:: year

      Year of publication.

      :type: str | None

   .. attribute:: title

      Title of the publication.

      :type: str | None

   .. attribute:: authors

      Authors of the publication.

      :type: list[str] | None


   .. py:attribute:: id
      :type:  aoptk.literature.id.ID


   .. py:attribute:: pmcid
      :type:  aoptk.literature.id.PMCID | None
      :value: None



   .. py:attribute:: pmid
      :type:  aoptk.literature.id.PMID | None
      :value: None



   .. py:attribute:: doi
      :type:  aoptk.literature.id.DOI | None
      :value: None



   .. py:attribute:: year
      :type:  int | None
      :value: None



   .. py:attribute:: title
      :type:  str | None
      :value: None



   .. py:attribute:: authors
      :type:  list[str] | None
      :value: None



   .. py:method:: __str__() -> aoptk.literature.id.ID


   .. py:method:: __eq__(other: object) -> bool

      Compare Metadata by their identifiers.



   .. py:method:: __hash__() -> int

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