pybliometrics.scopus.AbstractRetrieval¶

class pybliometrics.scopus.AbstractRetrieval(identifier=None, refresh=False, view='META_ABS', id_type=None, **kwds)[source]¶

Interaction with the Abstract Retrieval API.

Parameters:

identifier (str or int) – The identifier of a document. Can be the Scopus EID, the Scopus ID, the PII, the Pubmed-ID or the DOI.
refresh (bool or int (optional, default=False)) – Whether to refresh the cached file if it exists or not. If int is passed, cached file will be refreshed if the number of days since last modification exceeds that value.
id_type (str (optional, default=None)) – The type of used ID. Allowed values: None, ‘eid’, ‘pii’, ‘scopus_id’, ‘pubmed_id’, ‘doi’. If the value is None, the function tries to infer the ID type itself.
view (str (optional, default=META_ABS)) – The view of the file that should be downloaded. Allowed values: META, META_ABS, REF, FULL, where FULL includes all information of META_ABS view and META_ABS includes all information of the META view. For details see https://dev.elsevier.com/sc_abstract_retrieval_views.html.
kwds (key-value parings, optional) – Keywords passed on as query parameters. Must contain fields and values listed mentioned in the API specification (https://dev.elsevier.com/documentation/AbstractRetrievalAPI.wadl), such as “startref” or “refcount”.

Raises:

ValueError – If the id_type parameter or the view parameter contains invalid entries.

Examples

See https://pybliometrics.readthedocs.io/en/stable/examples/AbstractRetrieval.html.

Notes

The directory for cached results is {path}/{view}/{identifier}, where path is specified in ~/.scopus/config.ini. In case identifier is a DOI, an underscore replaces the forward slash.

abstract¶: The abstract of a document. Note: If this is empty, try property description instead.

affiliation¶: A list of namedtuples representing listed affiliations in the form (id, name, city, country). Note: Might be empty.

aggregationType¶: Aggregation type of source the document is published in.

authkeywords¶: List of author-provided keywords of the document.

authorgroup¶: A list of namedtuples representing the article’s authors organized by affiliation, in the form (affiliation_id, dptid, organization, city, postalcode, addresspart, country, auid, indexed_name, surname, given_name). If “given_name” is not present, fall back to initials. Note: Affiliation information might be missing or mal-assigned even when it lookes correct in the web view. In this case please request a correction.

authors¶: A list of namedtuples representing the article’s authors, in the form (auid, indexed_name, surname, given_name, affiliation_id, affiliation, city, country). Note: The affiliation referred to here is what Scopus’ algorithm determined as the main affiliation. Property authorgroup provides all affiliations.

citedby_count¶: Number of articles citing the document.

citedby_link¶: URL to Scopus page listing citing documents.

chemicals¶: List of namedtuples representing chemical entities in the form (source, chemical_name, cas_registry_number). In case multiple numbers given, they are joined on “;”.

confcode¶: Code of the conference the document belong to.

confdate¶: Date range of the conference the document belongs to represented by two tuples in the form (YYYY, MM, DD).

conflocation¶: Location of the conference the document belongs to.

confname¶: Name of the conference the document belongs to.

confsponsor¶: Sponsor(s) of the conference the document belongs to.

contributor_group¶: List of namedtuples representing contributors compiled by Scopus, in the form (given_name, initials, surname, indexed_name, role).

correspondence¶: namedtuple representing the author to whom correspondence should be addressed, in the form (surname, initials, organization, country, city_group). Multiple organziations are joined on semicolon.

coverDate¶: The date of the cover the document is in.

description¶: Return the description of a record. Note: If this is empty, try property abstract instead.

doi¶: DOI of the document.

eid¶: EID of the document.

endingPage¶: Ending page. If this is empty, try .pageRange instead.

funding¶: List of namedtuples parsed funding information in the form (agency string id acronym country).

funding_text¶: The raw text from which Scopus derives funding information.

isbn¶: ISBNs belonging to publicationName as tuple of variying length, (e.g. ISBN-10 or ISBN-13).

issn¶: ISSN belonging to the publicationName. Note: If E-ISSN is known to Scopus, this returns both ISSN and E-ISSN in random order separated by blank space.

identifier¶: ID of the document (same as EID without “2-s2.0-“).

idxterms¶: List of index terms (these are just one category of those Scopus provides in the web version) .

issueIdentifier¶: Number of the issue the document was published in.

issuetitle¶: Title of the issue the document was published in.

language¶: Language of the article.

openaccess¶: The openaccess status encoded in single digits.

openaccessFlag¶: Whether the document is available via open access or not.

pageRange¶: Page range. If this is empty, try .startingPage and .endingPage instead.

pii¶: The PII (Publisher Item Identifier) of the document.

publicationName¶: Name of source the document is published in.

publisher¶: Name of the publisher of the document. Note: Information provided in the FULL view of the article might be more complete.

publisheraddress¶: Name of the publisher of the document.

pubmed_id¶: The PubMed ID of the document.

refcount¶: Number of references of an article. Note: Requires either the FULL view or REF view.

references¶

List of namedtuples representing references listed in the document, in the form (position, id, doi, title, authors, authors_auid, authors_affiliationid, sourcetitle, publicationyear, volume, issue, first, last, citedbycount, type, text, fulltext). position is the number at which the reference appears in the document, id is the Scopus ID of the referenced document (EID without the “2-s2.0-“), authors is a string of the names of the authors in the format “Surname1, Initials1; Surname2, Initials2”, authors_auid is a string of the author IDs joined on “; “, authors_affiliationid is a string of the authors’ affiliation IDs joined on “; “, sourcetitle is the name of the source (e.g. the journal), publicationyear is the year of the publication as a string, volume and issue, are strings referring to the volume and issue, first and last refer to the page range, citedbycount is a string for the total number of citations of the cited item, type describes the parsing status of the reference (resolved or not), text is Scopus-provided information on the publication, fulltext is the text the authors used for the reference.

Note: Requires either the FULL view or REF view. Might be empty even if refcount is positive. Specific fields can be empty. Author lists (authors, authors_auid, authors_affiliationid) may contain duplicates but None’s have been filtered out.

scopus_link¶: URL to the document page on Scopus.

self_link¶: URL to Scopus API page of this document.

sequencebank¶: List of namedtuples representing biological entities defined or mentioned in the text, in the form (name, sequence_number, type).

source_id¶: Scopus source ID of the document.

sourcetitle_abbreviation¶: Abbreviation of the source the document is published in. Note: Requires the FULL view of the article.

srctype¶: Aggregation type of source the document is published in (short version of aggregationType).

startingPage¶: Starting page. If this is empty, try .pageRange instead.

subject_areas¶: List of namedtuples containing subject areas of the article in the form (area abbreviation code). Note: Requires the FULL view of the article.

subtype¶: Type of the document. Refer to the Scopus Content Coverage Guide for a list of possible values. Short version of subtypedescription.

subtypedescription¶: Type of the document. Refer to the Scopus Content Coverage Guide for a list of possible values. Long version of subtype.

title¶: Title of the document.

url¶: URL to the API view of the document.

volume¶: Volume for the document.

website¶: Website of publisher.

get_bibtex()[source]¶

Bibliographic entry in BibTeX format.

Raises:	`ValueError` – If the item’s aggregationType is not Journal.

get_html()[source]¶: Bibliographic entry in html format.

get_latex()[source]¶: Bibliographic entry in LaTeX format.

get_ris()[source]¶

Bibliographic entry in RIS (Research Information System Format) format for journal articles.

Raises:	`ValueError` – If the item’s aggregationType is not Journal.

get_cache_file_age()¶: Return the age of the cached file in days.

get_cache_file_mdate()¶: Return the modification date of the cached file.

get_key_remaining_quota()¶: Return number of remaining requests for the current key and the current API (relative on last actual request).

get_key_reset_time()¶: Return time when current key is reset (relative on last actual request).