Outputs in top citation percentiles metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, entity

Outputs in top citation percentiles metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, e

Publications in top journal percentiles metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, en

Publications in top journal percentiles metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_i

Related topics for the topic. Returns list of RelatedTopic namedtuples with structure: (entity_id, entity_name, related_topic_id, rela

Scholarly output metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric, year

Scholarly output metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric,

Scholarly output metrics for each topic. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric, year,

Top authors for the topic. Returns list of TopAuthor namedtuples with structure: (entity_id, entity_name, author_id, author_name, publ

Top cited publications for the topic. Returns list of TopPublication namedtuples with structure: (entity_id, entity_name, publication_

Top institutions for the topic. Returns list of TopInstitution namedtuples with structure: (entity_id, entity_name, institution_id, in

Top journals for the topic. Returns list of TopJournal namedtuples with structure: (entity_id, entity_name, journal_id, journal_name,

Top keywords for the topic. Returns list of TopKeyword namedtuples with structure: (entity_id, entity_name, keyword_name, keyword_uri,

Interaction with the Affiliation Search API. :param query: A string of the query. For allowed fields and values see ht

Interaction with the Author Search API. :param query: A string of the query. For allowed fields and values see https:/

Interaction with the PlumX Metrics API. :param identifier: The identifier of a document. :param id_type: The type of used ID. Allowed

Interaction with the Subject Classifications Scopus API. :param query: Query parameters and corresponding fields. Allowed keys

Interaction with the Citation Overview API. :param identifier: Up to 25 identifiers of the same kind for which to look

Interaction with the Scopus Search API. :param query: A string of the query as used in the Advanced Search on scopus.com

Interaction with the Abstract Retrieval API. :param identifier: The identifier of a document. Can be the Scopus EID

Interaction with the Affiliation Retrieval API. :param aff_id: Scopus ID or EID of the affiliation profile. :param refresh: Whether t

Interaction with the base endpoint of the `Serial Title API`. :param query: Query parameters and corresponding fields. Allowed keys

Interaction with the Author Retrieval API. :param author_id: The ID or the EID of the author. :param refresh: Whether to refresh the

Interaction with the `ISSN` endpoint of the `Serial Title API`. Class retrieves data from both Scopus and ScienceDirect. :param issn:

Interaction with the ScienceDirect Subject Classifications API. :param query: Query parameters and corresponding fields. Allowed keys

Interaction with the Article Retrieval API. :param identifier: The indentifier of an article. :param refresh: Whether to refr

Interaction with the ScienceDirect Search API. This represents a search against the ScienceDirect cluster, which contains serial/nonserial ful

Class to retrieve the metadata of all objects of a document. :param identifier: The indentifier of an article. :param view: The view

Class to retrieve a specific object of a document by its filename. :param identifier: The indentifier of the document. :param filenam

Interaction with the ScienceDirect Article Metadata API. :param query: A string of the query as used in the `Advanced Search <https://dev.els

Interaction with the ScienceDirect Nonserial Title API. :param isbn: The ISBN of the book. :param view: The view of the file that sho

Class intended as superclass to perform retrievals. :param identifier: The ID to look for. :param id_type: The type of the used ID.

Class intended as base class for superclasses. :param params: Dictionary used as header during the API request. :param url: The URL t

Class intended as superclass to perform a search query. :param query : A string of the query. :param cursor: Whether to use the curso

Interaction with the SciVal Author Metrics API. :param author_ids: Scopus Author ID(s). Can be a single ID or comma-separated

Interaction with the SciVal's `metrics` endpoint of the `InstitutionLookup API`. :param institution_ids: SciVal Institution ID(s). Can be a s

Interaction with the Publication Lookup API. :param identifier: The Scopus ID of the publication. :param refresh: Whether to refresh

Interaction with the SciVal's `metrics` endpoint of the `TopicLookup API`. :param topic_ids: SciVal Topic ID(s). Can be a single ID or comma-

Return a summary string.

Print a summary string.

Print a summary string.

Print a summary string.

Return a summary string.

Print a summary string.

Return pretty text version of the document. Assumes the document is a journal article and was loaded with view="META_ABS" or view="FU

Return a summary string.

Print a summary string.

Return a summary string.

Print a summary string.

Print a summary string.

Return a string with the filename, document and object size in KB.

Print a summary string.

Return a citation string for the Nonserial Title.

Return pretty text version of the author metrics.

Return pretty text version of the institution metrics.

Return pretty text version of the document.

Return pretty text version of the topic metrics.

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

The abstract of a document.

The address of the affiliation.

A list of namedtuples representing listed affiliations in the form `(id, name, city, country)`.

A list of namedtuples representing the authors's current affiliation(s), in the form `(id parent type relationship afdispname preferre

A list of namedtuples representing the authors's historical affiliation(s), in the form `(id parent type relationship afdispname prefe

The name of the affiliation.

A list of Affiliation namedtuples storing affiliation information, where each namedtuple corresponds to one affiliation. The informati

Aggregation type of source the document is published in.

The aggregation type of a document.

The type of the source.

The type of the source.

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

List of author-provided keywords of the document.

Number of authors associated with the affiliation.

A list of namedtuples representing the article's authors and collaborations organized by affiliation, in the form `(affiliation_id, collaborat

A list of namedtuples storing author information, where each namedtuple corresponds to one author. The information in each namedtuple

A list of lists of namedtuples storing author information, where each namedtuple corresponds to one author and each sub-list to one do

A list of namedtuples representing the article's authors, in the form `(auid, indexed_name, surname, given_name, affiliation)`. In case

The authors of a document.

The authors of the book.

A list of namedtuples representing authors and their basic info in the form `(id, name, uri)`.

A list of namedtuples representing listed authors in the form `(id, name, uri)`.

A list of namedtuples representing metrics in the Captures category. Note: For details on Capture metrics see https://plumanalytics.c

A list of namedtuples representing total metrics as categorized by PlumX Metrics in the form `(capture, citation, mention, socialMedia,

List of lists of tuples of yearly number of citations for specified years, where each sub-list corresponds to one document.

List of namedtuples representing chemical entities in the form `(source, chemical_name, cas_registry_number)`. In case multiple numbe

A list of namedtuples representing citation counts from different sources. Note: For details on Citation metrics see https://

Type (long version) of the documents (e.g. article, review).

Type (short version) of the documents (e.g. ar, re).

Total number of citing items.

Count of citations.

Total number of citing authors.

Number of articles citing the document.

URL to Scopus page listing citing documents.

A list of named tuples of the form: `(year citescore)` or (when `view="CITESCORE"`) `(year citescore status documentcount citationcount

The city of the affiliation.

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