collection_metrics: Retrives metadata on a valid ImpactStory collection ID

In ropensci/rImpactStory: Retrieves altmetrics from ImpactStory

Retrives metadata on a valid ImpactStory collection ID

Description

Retrives metadata on a valid ImpactStory collection ID

Usage

  collection_metrics(collection_id = NULL,
    key = getOption("ImpactStoryKey", stop("Missing ImpactStory consumer key")),
    as.csv = FALSE)

Arguments

key	An ImpactStory API key
collection_id	An Impact Story collection id
as.csv	Default is FALSE. Set to TRUE to return a .csv file. Use in conjunction with save_collection

Value

a list with the following fields:

_id	id #
_rev	revision #
created	created on
ip_address	ip address of creation
items	list of items
key_hash
last_modified
owner
title
type

.

Author(s)

Karthik Ram [e-mail]

Examples

## Not run: 
collection_metrics('kn5auf')

## End(Not run)

ropensci/rImpactStory documentation built on May 18, 2022, 6:30 p.m.