pybliometrics.scopus.AuthorRetrieval

class pybliometrics.scopus.AuthorRetrieval(author_id, refresh=False, view='ENHANCED')[source]

Interaction with the Author Retrieval API.

Parameters:
  • author_id (str or int) – The ID of the author to search for. Optionally expressed as an Elsevier EID (i.e., in the form 9-s2.0-nnnnnnnn).
  • 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.
  • view (str (optional, default=META_ABS)) – The view of the file that should be downloaded. Allowed values: METRICS, LIGHT, STANDARD, ENHANCED, where STANDARD includes all information of LIGHT view and ENHANCED includes all information of any view. For details see https://dev.elsevier.com/sc_author_retrieval_views.html. Note: Neither the BASIC nor the DOCUMENTS view are not active, although documented.

Examples

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

Notes

The directory for cached results is {path}/ENHANCED/{author_id}, where path is specified in ~/.scopus/config.ini and author_id is stripped of an eventually leading ‘9-s2.0-‘.

affiliation_current

A list of namedtuples representing the authors’s current affiliation(s), in the form (id parent type relationship afdispname preferred_name parent_preferred_name country_code country address_part city state postal_code org_domain org_URL). 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.

affiliation_history

A list of namedtuples representing the authors’s historical affiliation(s), in the form (id parent type relationship afdispname preferred_name parent_preferred_name country_code country address_part city state postal_code org_domain org_URL). 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.

Note: Unlike on their website, Scopus doesn’t provide the periods of affiliation.

alias

Set of possible new Scopus Author Profile IDs in case the profile has been merged.

citation_count

Total number of citing items.

cited_by_count

Total number of citing authors.

coauthor_count

Total number of coauthors.

classificationgroup

List with (subject group ID, number of documents)-tuples.

URL to Scopus API search page for coauthors.

date_created

Date the Scopus record was created.

document_count

Number of documents authored (excludes book chapters and notes).

eid

The EID of the author. If it differs from the one provided, pybliometrics will throw a warning informing the user about author profile merges.

given_name

Author’s preferred given name.

h_index

The author’s h-index.

historical_identifier

Scopus IDs of previous profiles now compromising this profile.

identifier

The author’s ID. Might differ from the one provided.

indexed_name

Author’s name as indexed by Scopus.

initials

Author’s preferred initials.

name_variants

List of named tuples containing variants of the author name with number of documents published with that variant.

orcid

The author’s ORCID.

publication_range

Tuple containing years of first and last publication.

Link to the Scopus web view of the author.

URL to the API page listing documents of the author.

Link to the author’s API page.

status

The status of the author profile.

subject_areas

List of named tuples of subject areas in the form (area, abbreviation, code) of author’s publication.

surname

Author’s preferred surname.

url

URL to the author’s API page.

get_coauthors()[source]

Retrieves basic information about co-authors as a list of namedtuples in the form (surname, given_name, id, areas, affiliation_id, name, city, country), where areas is a list of subject area codes joined by “; “. Note: Method retrieves information via individual queries which will not be cached. The Scopus API returns 160 coauthors at most.

get_documents(subtypes=None, **kwds)[source]

Return list of the author’s publications using a ScopusSearch() query, where publications may fit specified set of document subtypes.

Parameters:
  • subtypes (list of str (optional, default=None)) – The type of documents that should be returned.
  • **kwds (dict-like) – Parameters to be passed on to ScopusSearch().
Returns:

results – The same type of results returned from any ScopusSearch().

Return type:

list of namedtuple

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_document_eids(*args, **kwds)[source]

Return list of EIDs of the author’s publications using a ScopusSearch() query.

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

estimate_uniqueness(query=None, *args, **kwds)[source]

Estimate how unqiue a profile is by get the number of matches of an AuthorSearch for this person.

Parameters:
  • query (str (optional, default=None)) – The query string to perform to search for authors. If empty, the query is of form “AUTHLAST() AND AUTHFIRST()” with the corresponding information included. Provided queries may include “SUBJAREA()” OR “AF-ID() AND SUBJAREA()”. For details see https://dev.elsevier.com/tips/AuthorSearchTips.htm.
  • kwds (args,) – Parameters to be passed on to AuthorSearch().
Returns:

n – The number of matches of the query.

Return type:

int