Description Usage Arguments Value Examples
View source: R/get_elements_code_tables.R
get_element_codetables()
retrieves metadata about
code tables. A code table defines a small number of discrete values for
an element. The function requires input for client_id
. The other
function arguments are optional, and default to NULL
, which means
that the response from the API is not filtered on these parameters.
1 2 3 4 5 |
client_id |
A string. The client ID to use to send requests to the Frost API. |
ids |
A character vector. The element IDs to get metadata for. |
fields |
A character vector. The field to include in the response (i.e. output). If this parameter is set, then only the specified field is returned as a data frame. If not set, then all fields will be returned in the response as a list. The options are "summarized" and "details". |
language |
A string. The language of the fields in the response. The options are "en-US" (default), "nb-NO" (Norwegian, Bokmål), and "nn-NO" (Norwegian, Nynorsk). |
return_response |
A logical. If set to |
The function returns either a data frame with metadata about code
tables, or the response of the GET request, depending on the boolean value
set for return_response
.
1 2 3 4 5 6 7 | ## Not run:
frost_client_id <- "<YOUR FROST CLIENT ID>"
# Get the full code table
code_tables <- get_element_codetables(client_id = frost_client_id)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.