tsg_search_grants: Search for specific datasets

In evanodell/threesixtygiving: Download Charitable Grants from the '360Giving' Platform

Description

Returns a list of tibbles with details of all grants from specific funders.

Usage

tsg_search_grants(
  search,
  search_in = NULL,
  verbose = TRUE,
  ignore_case = TRUE,
  perl = FALSE,
  fixed = FALSE,
  ...
)

Arguments

search	The string(s) to search for. By default allows POSIX 1003.2 regular expressions. Use perl = TRUE for perl-style regex, or fixed = TRUE for fixed strings. Accepts single strings or a character vector of strings.
search_in	The name of the column to search in. Accepts single strings or a character vector of column names. If NULL, searches all columns.
verbose	If TRUE, prints console messages on data retrieval progress. Defaults to TRUE.
ignore_case	If TRUE ignores case.
perl	If TRUE, uses perl-style regex.
fixed	If TRUE, searches will be matched as-is.
...	Additional params passed to tsg_all_grants()

Details

tsg_search_grants retrieves grants where funder data matches one or more search strings. If only one dataset matches queries, returns a tibble of that dataset. Use tsg_specific_df() to pass a dataframe.

Value

A single tibble (if only one grant maker matches the queries) or a list of tibbles (if the query matches multiple datasets).

See Also

tsg_search_funders() for retrieving information on available datasets from matching funders. tsg_specific_df() to retrieve data contained with all or specific rows of a tibble returned by tsg_available() or tsg_missing().

Examples

## Not run: 
specific1 <- tsg_search_grants(search = c("bbc", "caBinet"))

## End(Not run)

evanodell/threesixtygiving documentation built on Dec. 1, 2020, 11:29 p.m.