opensensemap/opensensmapR
1
0
Fork 0
mirror of https://github.com/sensebox/opensensmapr synced 2025-02-20 20:23:58 +01:00
Code Issues Releases Wiki Activity

fix docs

Browse source
This commit is contained in:
Norwin 2017-11-30 14:01:41 +01:00
parent dcc5498267
commit 9444ea1702
Signed by: norwin
GPG key ID: 24BC059DE24C43A3
2 changed files with 12 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
R/opensensmapr.R
View file

@ -7,7 +7,7 @@
#' \item general statistics about the openSenseMap database.
#' }
#' Additionally, helper functions are provided to ease the integration with the
#' \code{\link{sf}} package for spatial analysis as well as \code{\link{deplyr}}
#' \code{\link{sf}} package for spatial analysis as well as \code{\link{dplyr}}
#' for general data handling.
#'
#' @section Retrieving senseBox metadata:
@ -18,10 +18,9 @@
#' senseBoxes can be retrieved either by ID, or as a collection with optional
#' filters on their metadata
#' \itemize{
#' \item \code{\link{osem_box}}: Get metadata about a single box
#' by its ID.
#' \item \code{\link{osem_boxes}}: Get metadata about a all
#' boxes. Optionally filtered by their attributes.
#' \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
@ -50,8 +49,7 @@
#' \item a exposure type of the given box
#' }
#'
#' Data is returned as \code{data.frame} with the class \code{osem_measurements}.
#' The provided columns may
#' 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}}.
@ -65,7 +63,7 @@
#' 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
#' \code{\link{deplyr}}.
#' \code{\link{dplyr}}.
#' }
#'
#' @seealso Report bugs at \url{https://github.com/noerw/opensensmapR/issues}

14
man/opensensmapr.Rd
View file

@ -14,7 +14,7 @@ The opensensmapr package provides functions for
\item general statistics about the openSenseMap database.
}
Additionally, helper functions are provided to ease the integration with the
\code{\link{sf}} package for spatial analysis as well as \code{\link{deplyr}}
\code{\link{sf}} package for spatial analysis as well as \code{\link{dplyr}}
for general data handling.
}
\section{Retrieving senseBox metadata}{
@ -26,10 +26,9 @@ 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{
\item \code{\link{osem_box}}: Get metadata about a single box
by its ID.
\item \code{\link{osem_boxes}}: Get metadata about a all
boxes. Optionally filtered by their attributes.
\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
@ -60,8 +59,7 @@ given phenomenon only. A subset of measurements may be selected by
\item a exposure type of the given box
}
Data is returned as \code{data.frame} with the class \code{osem_measurements}.
The provided columns may
Data is returned as \code{tibble} with the class \code{osem_measurements}.
}
\section{Retrieving statistics}{
@ -79,7 +77,7 @@ Helpers are implemented to ease the further usage of the retrieved data:
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
\code{\link{deplyr}}.
\code{\link{dplyr}}.
}
}