ISid: Retrieves the ImpactStory ID for a given object. (These...

View source: R/tiID.R

ISidR Documentation

Retrieves the ImpactStory ID for a given object. (These functions will get deprecated in the next version of the API.)

Description

If an object was previously queried at ImpactStory, it will have a ImpactStory ID and this function will retrive that ID which can then be used to retrieve the latest metrics or add the item to a collection using create_collection. If the object doesn't exist in ImpactStory, this will call create_ISid and return the newly assigned ID.

Usage

  ISid(key = getOption("ImpactStoryKey", stop("Missing Dropbox consumer key")),
    id = NULL, nspace = "doi")

Arguments

key

An ImpactStory API key

id

Any object ID

nspace

Default is doi but can be changed to github, url, pmid. Others such as Mendeley and arXiv are forthcoming.

Value

list if a valid ImpactStory ID was found. Otherwise returns an error.

Author(s)

Karthik Ram karthik.ram@gmail.com

See Also

create_collection

Examples

## Not run: 
ISid('10.1038/nrg3270')

## End(Not run)

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