scopus.AbstractRetrieval

class scopus.AbstractRetrieval(identifier=None, view='META_ABS', refresh=False, id_type=None, EID=None)[source]

Class to represent the results from a Scopus abstract.

Parameters:
  • identifier (str or int) – The identifier of an abstract. Can be the Scoups EID, the Scopus ID, the PII, the Pubmed-ID or the DOI.
  • EID (str (deprecated since 1.2)) – Deprecated in favor of identifier, will be removed in a future release.
  • 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. Will not take effect for already cached files. 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 . See https://dev.elsevier.com/guides/AbstractRetrievalViews.htm for details.
  • refresh (bool (optional, default=False)) – Whether to refresh the cached file if it exists or not.
  • ValueError – If the id_type parameter or the view parameter contains invalid entries.

Notes

The files are cached in ~/.scopus/abstract_retrieval/{identifier}. In case a DOI is used as identifier, an underscore replaces the forward slash in the filename.

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.
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 abstract is published in.

authkeywords

List of author-provided keywords of the abstract.

authorgroup

A list of namedtuples representing the article’s authors organized by affiliation, in the form (affiliation_id, organization, city_group, 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.

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 “;”.

citedby_count

Number of articles citing the abstract.

URL to Scopus page listing citing documents.

confcode

Code of the conference the abstract belong to.

confdate

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

conflocation

Location of the conference the abstract belongs to.

confname

Name of the conference the abstract belongs to.

confsponsor

Sponsor(s) of the conference the abstract 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).

coverDate

The date of the cover the abstract is in.

description

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

doi

DOI of the abstract.

eid

EID of the abstract.

endingPage

Ending page.

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.

identifier

ID of the abstract (same as EID without “2-s2.0-“).

idxterms

List of index terms.

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.

issueIdentifier

Issue number for abstract.

issuetitle

Title of the issue the abstract is published in.

language

Language of the article.

pageRange

Page range.

publicationName

Name of source the abstract is published in.

publisher

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

publisheraddress

Name of the publisher of the abstract.

refcount

Number of references of an article. Note: Requires the FULL view of the article.

references

List of namedtuples representing references listed in the abstract, in the form (position, id, doi, title, authors, authors_auid, authors_affiliationid, sourcetitle, publicationyear, volume, issue, first, last, citedbycount, text, fulltext). position is the number at which the reference appears in the document, id is the Scopus ID of the referenced abstract (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, 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 of the article. Might be empty even if refcount is positive. Specific fields can be empty. Author lists (authors, authors_auid, authors_affiliationid) may contain duplicates but have been filtered of None’s.

URL to the abstract page on Scopus.

URL to Scopus API page of this abstract.

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 abstract.

sourcetitle_abbreviation

Abbreviation of the source the abstract is published in. Note: Requires the FULL view of the article.

srctype

Aggregation type of source the abstract is published in (short version of aggregationType.

startingPage

Starting page.

subject_areas

List of namedtuples containing subject areas of the article in the form (). Note: Requires the FULL view of the article.

title

Title of the abstract.

url

URL to the API view of the abstract.

volume

Volume for the abstract.

website

Website of publisher.