nih_fields: NIH RePORTER Field Translation

In bikeactuary/repoRter.nih: R Interface to the 'NIH RePORTER Project' API

NIH RePORTER Field Translation

Description

A tibble containing name translations between payload criteria, column selection/sorting arguments, and the result set.

Usage

data("nih_fields")

Format

A tibble with 43 rows and 5 columns:

payload_name

the name for a data element when specified in the payload criteria of a request; NA indicates that this is not available as payload criteria (can not search/filter on).

response_name

the name of the field returned by RePORTER (and what you will see in all cases when flatten_result = FALSE.

include_name

the name of the field when specified in include_fields, exclude_fields, and sort_field argument.

return_class

the class of the corresponding column in a tibble returned by get_nih_data(). The tibble contains nested data frames and lists of variable length vectors.

Note: when flatten_result = TRUE, the original field name will prefix the names of the new flattened columns. See: jsonlite:flatten.

References

NIH RePORTER API Documentation

bikeactuary/repoRter.nih documentation built on Feb. 6, 2023, 8:05 p.m.