Usage

opencitations_client Package

Access and download data from OpenCitations.

Functions

ensure_citation_data_csv()	Ensure the citation data in CSV format (38.8 GB zipped, 242 GB uncompressed).
ensure_citation_data_nt()	Ensure the citation data in n-triple format (87.4 GB zipped, 2.1 TB uncompressed).
ensure_citation_data_scholix()	Ensure the citation data in Scholix format (45 GB zipped, 2.1 TB uncompressed).
ensure_metadata_csv()	Ensure the metadata in CSV format (12 GB compressed, 49 GB uncompressed).
ensure_metadata_kubernetes()	Ensure the metadata in Kubernetes format (39 GB compressed, 187 GB uncompressed).
ensure_metadata_rdf()	Ensure metadata/provenance data in RDF format (46.5 GB compressed, 66 GB uncompressed).
ensure_provenance_data_csv()	Ensure the provenance data in CSV format (20 GB zipped, 454 GB uncompressed).
ensure_provenance_data_nt()	Ensure the provenance data in n-triples format (105 GB zipped, 3.4 TB uncompressed).
ensure_provenance_rdf()	Ensure the provenance data in RDF format (154 GB compressed, 1 TB uncompressed).
ensure_source_csv()	Ensure the source data in CSV format (25.7 GB zipped, 426 GB uncompressed).
ensure_source_nt()	Ensure the source data in NT format (23 GB zipped, 104 GB uncompressed).
get_articles(references, *[, token])	Get documents by reference.
get_articles_for_author(reference, *[, token])	Get documents incident to the author.
get_articles_for_editor(reference, *[, token])	Get documents incident to the editor.
get_doi_from_omid(omid)	Get a DOI for the given OMID.
get_doi_to_omid(*[, force_process])	Get a mapping from DOIs to OMIDs.
get_incoming_citations()	Get the articles that cite a given article, from OpenCitations.
get_incoming_citations_from_api()	Get the articles that cite a given article, from OpenCitations.
get_omid_from_doi(doi)	Get an OMID for the given DOI.
get_omid_from_pubmed(pubmed)	Get an OMID for the given PubMed ID.
get_omid_to_doi(*[, force_process])	Get OMID to DOI dictionary.
get_omid_to_pubmed(*[, force_process])	Get a mapping from OMIDs to PubMed identifiers.
get_outgoing_citations()	Get the articles that the given article cites, from OpenCitations.
get_outgoing_citations_from_api()	Get the articles that the given article cites, from OpenCitations.
get_pubmed_from_omid(omid)	Get a PubMed ID for the given OMID.
get_pubmed_to_omid(*[, force_process])	Get a mapping from PubMed identifiers to OMIDs.

Classes

Citation(*, reference, citing, cited[, ...])	Wraps the results from a citation.
Person(*, name, references)	Represents an author in OpenCitations.
Publisher(*, name, references)	Represents a publisher in OpenCitations.
Venue(*, name, references)	Represents a venue in OpenCitations.
Work(*, references, title, authors[, ...])	A representation of metadata for a creative work.

Class Inheritance Diagram

digraph inheritancee012fbd63c { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "Citation" [URL="api/opencitations_client.Citation.html#opencitations_client.Citation",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wraps the results from a citation."]; "BaseModel" -> "Citation" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Person" [URL="api/opencitations_client.Person.html#opencitations_client.Person",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents an author in OpenCitations."]; "BaseModel" -> "Person" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Publisher" [URL="api/opencitations_client.Publisher.html#opencitations_client.Publisher",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a publisher in OpenCitations."]; "BaseModel" -> "Publisher" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Venue" [URL="api/opencitations_client.Venue.html#opencitations_client.Venue",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a venue in OpenCitations."]; "BaseModel" -> "Venue" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Work" [URL="api/opencitations_client.Work.html#opencitations_client.Work",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A representation of metadata for a creative work."]; "BaseModel" -> "Work" [arrowsize=0.5,style="setlinewidth(0.5)"]; }