export check api key function

NAMESPACE

@@ -1,4 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
+export(check_api_key)
 export(get_sensor_data)
 export(get_sensors_data)

R/check_api_key.R

@@ -1,4 +1,15 @@
-# https://api.purpleair.com/#api-keys-check-api-key
+#' check purple air api key
+#' 
+#' Use the PurpleAir API to validate your Purple Air API Key.
+#' Find more details on this function at https://api.purpleair.com/#api-keys-check-api-key
+#' @param purple_air_api_key A character that is your PurpleAir API `READ` key
+#' @returns if the key is valid, a message is emitted and the input is invisibly returned;
+#' invalid keys will throw an R error which utilizes information from the underlying http error
+#' to inform the user
+#' @export
+#' @examples
+#' check_api_key()
+#' try(check_api_key("foofy"))
 check_api_key <- function(purple_air_api_key = Sys.getenv("PURPLE_AIR_API_KEY")) {
   resp <- purple_air_request(
     purple_air_api_key = purple_air_api_key,

R/get_sensors_data.R

@@ -4,7 +4,7 @@
 #' Find more details on sensor fields at https://api.purpleair.com/#api-sensors-get-sensors-data.
 #' @param x an input object used to define multiple sensors  
 #' - st_bbox object will select sensors geographically (`nwlat`, `nwlon`, `selat`, `selon`)
-#' - integer vector will select sensors based on `sensor_index` (`show_only`)
+#' - integer (or numeric or character?) vector will select sensors based on `sensor_index` (`show_only`)
 #' - POSIXct object will select sensors modified since then (`modified_since`)
 #' @param fields A character vector of which 'sensor data fields' to return
 #' @param location_type character; restrict to only "outside" or "inside" sensors (Outside: 0, Inside: 1)