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.
opensensmapR/man/opensensmapr.Rd

91 lines
3.1 KiB
Plaintext

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/opensensmapr.R
\docType{package}
\name{opensensmapr}
\alias{opensensmapr}
\alias{opensensmapr-package}
\alias{opensensmapr-package}
\title{opensensmapr: Get sensor data from opensensemap.org}
\description{
The opensensmapr package provides functions for
\itemize{
\item retrieval of senseBox metadata,
\item retrieval of senseBox measurements,
\item general statistics about the openSenseMap database.
}
Additionally, helper functions are provided to ease the integration with the
7 years ago
\code{\link{sf}} package for spatial analysis as well as \code{\link{dplyr}}
for general data handling.
}
\section{Retrieving senseBox metadata}{
On the openSenseMap, measurements are provided by sensors which are assigned
to a sensor station ("senseBox").
A senseBox consists of a collection of sensors, a location (-history), an ID,
as well as metadata about its owner & placement.
senseBoxes can be retrieved either by ID, or as a collection with optional
filters on their metadata
\itemize{
7 years ago
\item \code{\link{osem_box}}: Get metadata about a single box by its ID.
\item \code{\link{osem_boxes}}: Get metadata about all boxes, optionally
filtered by their attributes.
}
The data is returned as a \code{\link{data.frame}} with the class
\code{sensebox} attached.
To help in getting an overview of the dataset additional functions are
implemented:
\itemize{
\item \code{summary.sensebox()}: Aggregate the metadata about the given
list of senseBoxes.
\item \code{plot.sensebox()}: Shows the spatial distribution of the given
list of senseBoxes on a map. Requires additional packages!
\item \code{\link{osem_phenomena}}: Get a named list with
counts of the measured phenomena of the given list of senseBoxes.
}
}
\section{Retrieving measurements}{
Measurements can be retrieved through \code{\link{osem_measurements}} for a
given phenomenon only. A subset of measurements may be selected by
\itemize{
\item a list of senseBoxes, previously retrieved through
\code{\link{osem_box}} or \code{\link{osem_boxes}}.
\item a geographic bounding box, which can be generated with the
\code{\link{sf}} package.
\item a time frame
\item a exposure type of the given box
}
7 years ago
Data is returned as \code{tibble} with the class \code{osem_measurements}.
}
\section{Retrieving statistics}{
Count statistics about the database are provided with \code{\link{osem_counts}}.
}
\section{Integration with other packages}{
The package aims to be compatible with the tidyverse.
Helpers are implemented to ease the further usage of the retrieved data:
\itemize{
\item \code{\link{st_as_sf.sensebox}} & \code{\link{st_as_sf.osem_measurements}}:
Transform the senseBoxes or measurements into an \code{\link{sf}}
compatible format for spatial analysis.
\item \code{filter.sensebox()} & \code{mutate.sensebox()}: for use with
7 years ago
\code{\link{dplyr}}.
}
}
\seealso{
Report bugs at \url{https://github.com/noerw/opensensmapR/issues}
openSenseMap API: \url{https://api.opensensemap.org/}
official openSenseMap API documentation: \url{https://docs.opensensemap.org/}
}