get_fields {patentsview} | R Documentation |
Get list of retrievable fields
Description
This function returns a vector of fields that you can retrieve from a given
API endpoint (i.e., the fields you can pass to the fields
argument in
search_pv
). You can limit these fields to only cover certain
entity group(s) as well (which is recommended, given the large number of
possible fields for each endpoint).
Usage
get_fields(endpoint, groups = NULL)
Arguments
endpoint |
The API endpoint whose field list you want to get. See
|
groups |
A character vector giving the group(s) whose fields you want
returned. A value of |
Value
A character vector with field names.
Examples
# Get all assignee-level fields for the patents endpoint:
fields <- get_fields(endpoint = "patents", groups = "assignees")
#...Then pass to search_pv:
## Not run:
search_pv(
query = '{"_gte":{"patent_date":"2007-01-04"}}',
fields = fields
)
## End(Not run)
# Get all patent and assignee-level fields for the patents endpoint:
fields <- get_fields(endpoint = "patents", groups = c("assignees", "patents"))
## Not run:
#...Then pass to search_pv:
search_pv(
query = '{"_gte":{"patent_date":"2007-01-04"}}',
fields = fields
)
## End(Not run)