You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
1.3 KiB
R
45 lines
1.3 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/box.R
|
|
\name{osem_box}
|
|
\alias{osem_box}
|
|
\title{Get a single senseBox by its ID}
|
|
\usage{
|
|
osem_box(boxId, endpoint = osem_endpoint(), cache = NA)
|
|
}
|
|
\arguments{
|
|
\item{boxId}{A string containing a senseBox ID}
|
|
|
|
\item{endpoint}{The URL of the openSenseMap API instance}
|
|
|
|
\item{cache}{Whether to cache the result, defaults to false.
|
|
If a valid path to a directory is given, the response will be cached there. Subsequent identical requests will return the cached data instead.}
|
|
}
|
|
\value{
|
|
A \code{sensebox data.frame} containing a box in each row
|
|
}
|
|
\description{
|
|
Get a single senseBox by its ID
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
# get a specific box by ID
|
|
b = osem_box('57000b8745fd40c8196ad04c')
|
|
|
|
# get a specific box by ID from a custom (selfhosted) openSenseMap API
|
|
b = osem_box('51030b8725fd30c2196277da', 'http://api.my-custom-osem.com')
|
|
|
|
# get a specific box by ID and cache the response, in order to provide
|
|
# reproducible results in the future.
|
|
b = osem_box('51030b8725fd30c2196277da', cache = tempdir())
|
|
}
|
|
}
|
|
\seealso{
|
|
\href{https://docs.opensensemap.org/#api-Measurements-findAllBoxes}{openSenseMap API documentation (web)}
|
|
|
|
\code{\link{osem_phenomena}}
|
|
|
|
\code{\link{osem_boxes}}
|
|
|
|
\code{\link{osem_clear_cache}}
|
|
}
|