pybliometrics.scopus.PlumXMetrics

class pybliometrics.scopus.PlumXMetrics(identifier, id_type, refresh=False)[source]

Interaction with the PlumX Metrics API.

Parameters:
  • identifier (str) – The identifier of a document.
  • id_type (str) –
    The type of used ID. Allowed values are:
    • ’airitiDocId’
    • ’arxivId’
    • ’cabiAbstractId’
    • ’citeulikeId’
    • ’digitalMeasuresArtifactId’
    • ’doi’
    • ’elsevierId’
    • ’elsevierPii’
    • ’facebookCountUrlId’
    • ’figshareArticleId’
    • ’githubRepoId’
    • ’isbn’
    • ’lccn’
    • ’medwaveId’
    • ’nctId’
    • ’oclc’
    • ’pittEprintDscholarId’
    • ’pmcid’
    • ’pmid’
    • ’redditId’
    • ’repecHandle’
    • ’repoUrl’
    • ’scieloId’
    • ’sdEid’
    • ’slideshareUrlId’
    • ’smithsonianPddrId’
    • ’soundcloudTrackId’
    • ’ssrnId’
    • ’urlId’
    • ’usPatentApplicationId’
    • ’usPatentPublicationId’
    • ’vimeoVideoId’
    • ’youtubeVideoId’
  • 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.

Examples

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

Notes

The directory for cached results is {path}/ENHANCED/{identifier}, where path is specified in ~/.scopus/config.ini.

category_totals

A list of namedtuples representing total metrics as categorized by PlumX Metrics in the form (capture, citation, mention, socialMedia, usage). Note: Can be empty. Specific categories can be absent depending on existence of data and applicability of metrics to document type. For Citation category a maximum citation count across sources is shown. For details on PlumX Metrics categories see https://plumanalytics.com/learn/about-metrics/

capture

metrics that track when end users bookmark, favorite, become a reader, become a watcher, etc, i.e. metrics that indicate that someone wants to come back to the work. Note: Can be empty. Specific metrics can be absent depending on existence of data and applicability of metrics to document type. For details on Capture metrics see https://plumanalytics.com/learn/about-metrics/capture-metrics/

Type:A list of namedtuples representing metrics in Captures category
citation

A list of namedtuples representing citation counts from different sources. Note: Can be empty. For details and list of possible sources see https://plumanalytics.com/learn/about-metrics/citation-metrics/

mention

metrics that measure engagement with research. Note: Can be empty. Specific metrics can be absent depending on existence of data and applicability of metrics to document type. For details on Mention metrics see https://plumanalytics.com/learn/about-metrics/mention-metrics/

Type:A list of namedtuples representing metrics in Mentions category
social_media

metrics on promotion of research. Note: Can be empty. Specific metrics can be absent depending on existence of data and applicability of metrics to document type. For details on social media metrics see https://plumanalytics.com/learn/about-metrics/social-media-metrics/

Type:A list of namedtuples representing social media metrics
usage

metrics that capture interaction with and usage of research. Note: Can be empty. Specific metrics can be absent depending on existence of data and applicability of metrics to document type. For details on Usage metrics see https://plumanalytics.com/learn/about-metrics/usage-metrics/

Type:A list of namedtuples representing Usage category metrics
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).