From 9444ea1702d4d6ec34e7eab2bc2905bc5da947a4 Mon Sep 17 00:00:00 2001 From: Norwin Roosen Date: Thu, 30 Nov 2017 14:01:41 +0100 Subject: [PATCH] fix docs --- R/opensensmapr.R | 14 ++++++-------- man/opensensmapr.Rd | 14 ++++++-------- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/R/opensensmapr.R b/R/opensensmapr.R index 266be7d..1a3a712 100644 --- a/R/opensensmapr.R +++ b/R/opensensmapr.R @@ -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} diff --git a/man/opensensmapr.Rd b/man/opensensmapr.Rd index 39f4ab2..21c1d82 100644 --- a/man/opensensmapr.Rd +++ b/man/opensensmapr.Rd @@ -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}}. } }