Package: aiRly 0.1.0

Piotr Janus

aiRly: R Wrapper for 'Airly' API

Get information about air quality using 'Airly' <https://airly.eu/> API through R.

Authors:Piotr Janus [cre, aut]

aiRly_0.1.0.tar.gz
aiRly_0.1.0.zip(r-4.5)aiRly_0.1.0.zip(r-4.4)aiRly_0.1.0.zip(r-4.3)
aiRly_0.1.0.tgz(r-4.4-any)aiRly_0.1.0.tgz(r-4.3-any)
aiRly_0.1.0.tar.gz(r-4.5-noble)aiRly_0.1.0.tar.gz(r-4.4-noble)
aiRly_0.1.0.tgz(r-4.4-emscripten)aiRly_0.1.0.tgz(r-4.3-emscripten)
aiRly.pdf |aiRly.html✨
aiRly/json (API)
NEWS

# Install 'aiRly' in R:
install.packages('aiRly', repos = c('https://piotrekjanus.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/piotrekjanus/airly/issues

On CRAN:

2.70 score 2 scripts 195 downloads 9 exports 24 dependencies

Last updated 5 years agofrom:093f6f4756. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 22 2024
R-4.5-winOKOct 22 2024
R-4.5-linuxOKOct 22 2024
R-4.4-winOKOct 22 2024
R-4.4-macOKOct 22 2024
R-4.3-winOKOct 22 2024
R-4.3-macOKOct 22 2024

Exports:get_indexesget_installation_by_idget_installation_measurementsget_measurements_infoget_nearest_installationsget_nearest_measurementsget_point_measurementsremaining_requestsset_apikey

Dependencies:askpassclicurlfansigluehttrjsonlitelifecyclemagrittrmimeopensslpillarpkgconfigplyrR6Rcppreshape2rlangstringistringrsystibbleutf8vctrs

Readme and manuals

Help Manual

Help pageTopics
Return base url of Airly API v2.base_url
Get Airly apikey.get_apikey
Sends a request to the specified url and retrieves it's content..send_request
Adds the json extension to the given urladd_json_extension
Adds the given path to the given urladd_path
Asserts a given expression and throws an error if it returns FALSEassert
Checks whether apikey is correctly setassert_apikey
Checks whether apikey is correctly setassert_coordinates
Checks whether ids are correctly defined. If not throws an errorassert_ids
Creates an object representing Airly measurementbuild_current_df
Creates object containing information about history data for given API responsebuild_forecast_df
Creates object containing information about history data for given API responsebuild_history_df
Creates an object representing a response from the Airly API. Also every API call return information about current limits What is used to assign variables in pkg.envcreate_airly_api_response
Creates an object representing Airly locationcreate_airly_location
Creates an object representing Airly measurementcreate_airly_measurement
Creates a data.frame representing Airly metacreate_airly_meta
Creates a request url based on the given base url and passed paths. The json extensions is added automatically.create_request_url
Retrieves the response contentget_content
Get Airly available indexesget_indexes
Get Airly installation by idget_installation_by_id
Get Airly measurements for any geographical location given installation idget_installation_measurements
Get measures used in Airlyget_measurements_info
Get Airly nearest installations to given pointget_nearest_installations
Get Airly nearest measurements to given pointget_nearest_measurements
Get Airly measurements for any geographical locationget_point_measurements
Checks whether the given object is of the class airly_api_responseis_airly_api_response
Checks whether the given object is of the class airly_locationis_airly_location
Checks whether the given object is of the class airly_measurementis_airly_measurement
Parses a json responseparse_json
Print for "airly_measurement" type objectsprint.airly_measurement
Get information about remaining API requestsremaining_requests
Replaces NULL with NA for nested lists. Useful when NULL value leads to error while object castingreplace_null
Set Airly apikeyset_apikey
Checks if the given response is not empty and that it did not return an error http code.validate_airly_api_response
Checks whether the given object is correctly defined airly_location classvalidate_airly_location
Checks whether the given object is correctly defined airly_measurement classvalidate_airly_measurement
Checks whether the given object is correctly correctly definedvalidate_airly_meta