Package: nectar 0.0.0.9005

nectar: A Framework for Web API Packages

An opinionated framework for use within api-wrapping R packages.

Authors:Jon Harmon [aut, cre, cph], R Consortium [fnd]

# Install 'nectar' in R:

install.packages('nectar', repos = c('https://jonthegeek.r-universe.dev', 'https://cloud.r-project.org'))

On CRAN:

Last updated 2 months agofrom:00d480493a. Checks:6 OK, 3 NOTE. Indexed: yes.

Help page	Topics
Send a request to an API	call_api
Extract a pagination policy from a request	choose_pagination_fn
Discard empty elements	compact_nested_list
Use a provided function	do_if_fn_defined
Iteration helper for json cursors	iterate_with_json_cursor
Authenticate with an API key	req_auth_api_key
Setup a basic API request	req_init
Modify an API request for a particular endpoint	req_modify
Define a pagination policy for a request	req_pagination_policy
Perform a request with opinionated defaults	req_perform_opinionated
Append package information to user agent	req_pkg_user_agent
Prepare a request for an API	req_prepare
Define a tidy policy for a request	req_tidy_policy
Automatically choose a body parser	resp_body_auto
Extract tabular data from response body	resp_body_csv resp_body_tsv
Extract response body into list	resp_body_separate
Parse one or more responses	resp_parse resp_parse.default resp_parse.httr2_response
Extract and clean an API response	resp_tidy
Extract and clean a JSON API response	resp_tidy_json
Error informatively for unknown response types	resp_tidy_unknown
Ensure an argument is a length-1 character	stabilize_string
Normalize a URL	url_normalize
Add path elements to a URL	url_path_append