refimpact (version 1.0.0)

get_case_studies: Search and download case studies

Description

DEPRECATED - USE ref_get. This function uses the SearchCaseStudies method from the database API. The method requires at least one filtering parameter, which means you need to provide at least one argument to this function.

Usage

get_case_studies(ID = NULL, UKPRN = NULL, UoA = NULL, tags = NULL,
  phrase = NULL)

Arguments

ID

integer, can return multiple case studies if provided as a numeric vector. If this argument is provided then all other arguments will be ignored.

UKPRN

integer, filter for a specific institution using its UKPRN.

UoA

integer, filter for a specific Unit of Assessment.

tags

integer, filter for specific tag IDs. Can combine multiple tags if provided as a numeric vector. Multiple tags are combined with logical AND.

phrase

string, filter for a specific phrase. Currently only supports single words.

Value

Returns a data_frame (from the tibble package).

Details

This function returns a data_frame (from the tibble package) as it deals nicely with the nested data structures provided by the API. See the example code below for a demonstration of this behaviour.

Examples

# NOT RUN {
studies <- get_case_studies(ID = c(27,29))
studies
studies[1,"Continent"] # [] gives list element
studies[[1,"Continent"]] # [[]] gives contents
# }
# NOT RUN {

# }