about_IS: About ImpactStory

Description Usage Arguments Value Author(s) Examples

Description

Retrieves the latest information about the ImpactStory API. This package now requires an API key. You can obtain one by emailing team at impactstory dot org. Then the key can be saved in your .rprofile as options(ImpactStoryKey="YOUR_KEY") or specified inline with each function call. Any API call cannot go through without a valid key.

Usage

1
2
  about_IS(key = getOption("ImpactStoryKey", stop("Missing ImpactStory consumer key")),
    as.df = FALSE)

Arguments

key

An ImpactStory API key

as.df

Default is FALSE. Set this to TRUE if you would like a data.frame returned instead.

Value

list

Author(s)

Karthik Ram [email protected]

Examples

1
2
3
4
5
## Not run: 
about_IS()
about_IS(as.df = TRUE) # will return a nicely formatted data.frame

## End(Not run)

ropensci/rImpactStory documentation built on May 27, 2019, 5:31 p.m.