Helper function to perform a series of .get() methods on a dictionary or return the `default`. Parameters ---------- container : dict

Attempt a conversion to int type.

Function to initialize the pybliometrics library. For more information refer to the `official documentation <https://pybliometrics.readthedoc

Helper function to extract metric data for a specific metric type. Parameters ---------- json_data : dict The JSON response f

Raise a ValueError if a parameter value is not in the set of allowed values.

Helper function to turn an element into a list if it isn't a list yet.

Check if the metric data has all required fields.

Check if the metric data has all required fields.

Return `lst` unless all of its elements are empty.

Helper function to return the link at position `idx` from coredata.

Convert s to Unicode characters if possible.

Return the number of results (works even if download=False).

Return the modification date of the cached file.

Create string for str dunder of search classes.

Function to get the InstToken and overwrite InstToken in config if needed.

Function to get all the API keys and overwrite keys in config if needed.

Formats list of dicts of metrics into list of Metric namedtuples.

Raise ValueError if elements of a list are not present in a string.

Check integrity of specific fields in a list of tuples and perfom provided action.

Auxiliary function to deduplicate a list while preserving its order.

Method that tries to infer the type of abstract ID. Parameters ---------- sid : str The ID of an abstract on Scopus. Raises

Helper function to download a file and return its content. Parameters ---------- url : str The URL to be parsed. api : str

Return the number of Scopus author profiles similar to this profile via calls with `AuthorSearch()`. :param query: The query string t

Retrieves basic information about co-authors as a list of namedtuples in the form `(surname, given_name, id, areas, affiliation_id, na

Function to get the config parser.

EIDs of retrieved documents.

Auxiliary function to parse and format page range of a document.

Attempt a conversion to float type.

Helper function to parse date-created from profile.

Deprecated: Use SerialTitleISSN instead. This class is deprecated and will be removed.

Format a list of authors (Surname, Firstname and Firstname Surname).

Auxiliary function to change the keys of a dictionary.

Auxiliary function to parse SNIP and SJR lists.

Auxiliary function to replace None's with another value.

Auxiliary function to return items matching a special idtype.

Extract entity ID and name from a result. Parameters ---------- result : dict Entity result from API response entity_type

Helper function to remove non-digits characters from a string.

Find specific metric data in the metrics list. Parameters ---------- result : dict Author result from API response metric

Helper function to return freetoread information from search results.

Helper function to return the Scopus ID at a fixed position.

Attempt a conversion to bool type.

Helper function to parse list of affiliation-related information.

Title of the document.

Deprecated: Use SerialTitleSearch instead. This class is deprecated and will be removed.

Whether a file needs to be refreshed based on its age.

Formats list of dicts of metrics into list of Category namedtuples.

Auxiliary function to get all information contained in cite score information list for the `CITESCORE` view.

Get all references for `AbstractRetrieval` with view `REF`.

Auxiliary function to get the authors.

Get the EID of a document.

Auxiliary function to extract org information from affiliation for authorgroup.

Auxiliary function to join same elements of a list of dictionaries if the elements are not None.

Auxiliary function to collect and concatenate subject area data into string. Returns tuple of strings for subject area names, subject area codes

Auxiliary function to collect citescore data. Returns list of lists in the form `[mergedstatname, stat]`, where `mergedstatname` - dictionary

Auxiliary function to collect data on links. Returns list of lists in the form of `[linkname, link]`.

Auxiliary function to collect SNIP and SJR data. Returns list of lists in the form `[mergedstatname, stat]`, where `mergedstatname` - diction

Auxiliary function to collect yearly data. Returns list of lists in the form `[mergedstatname, stat]`, where `mergedstatname` - dictionary ke

Auxiliary function to check if default cache paths exist. If not, the paths are writen in the config.

Auxiliary function to check if API keys or InstTokens are set.

Auxiliary function to check if all sections exist.

Auxiliary function to create cache folders.

Initiates process to generate configuration file. :param config_dir: The location of the configuration file. :param keys: If you provide a li

Get and aggregate subject areas from Scopus AuthorSearch.

Bibliographic entry in BibTeX format. Raises ------ ValueError If the item's aggregationType is not Journal.

Return list of EIDs of the author's publications using a ScopusSearch() query. :param args: Parameters to be passed on to `ScopusSear

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

DOIs of retrieved documents.

EIDs of retrieved documents.

Bibliographic entry in html format.

Bibliographic entry in LaTeX format.

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

Auxiliary function to create a session

Format a list of authors (Surname, Firstname and Firstname Surname).

Auxiliary function to parse and format page range of a document.

Unified function to process all metric types. Parameters ---------- metric_data : dict The metric data from API response

Academic corporate collaboration metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, entity_na

Academic corporate collaboration metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, enti

Academic corporate collaboration impact metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, en

Academic corporate collaboration impact metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_i

Author count metrics for each topic. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric, year, val

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

Citation count metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric, y

Citation count metrics for each topic. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric, year, v

Citations per publication metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, met

Citations per publication metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, entity_name

Cited publications metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric, ye

Cited publications metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metri

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

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

Collaboration impact metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, metric,

Collaboration impact metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, entity_name, met

Core papers for the topic. Returns list of CorePaper namedtuples with structure: (entity_id, entity_name, publication_id).

Field weighted citation impact metrics for each author. Returns list of MetricData namedtuples with structure: (entity_id, entity_name

Field weighted citation impact metrics for each institution. Returns list of MetricData namedtuples with structure: (entity_id, entity

Field weighted citation impact metrics for each topic. Returns list of MetricData namedtuples with structure: (entity_id, entity_name,

H-indices metrics for each author (only available when by_year=False). Returns list of MetricData namedtuples with structure: (entity_

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

Most recently published papers for the topic. Returns list of RecentPaper namedtuples with structure: (entity_id, entity_name, publica