From 92083ad38a9e327f9469845acc72c988533a13b1 Mon Sep 17 00:00:00 2001 From: Alec Robitaille Date: Tue, 24 Jul 2018 12:06:47 -0700 Subject: [PATCH] spelling --- R/group_polys.R | 6 +++--- R/group_pts.R | 2 +- R/group_times.R | 6 +++--- R/randomizations.R | 2 +- README.Rmd | 2 +- README.md | 2 +- man/build_polys.Rd | 2 +- man/group_polys.Rd | 6 +++--- man/group_pts.Rd | 2 +- man/group_times.Rd | 6 +++--- man/randomizations.Rd | 2 +- vignettes/intro-spatsoc.Rmd | 2 +- 12 files changed, 20 insertions(+), 20 deletions(-) diff --git a/R/group_polys.R b/R/group_polys.R index a48b27d5..a3585ca9 100644 --- a/R/group_polys.R +++ b/R/group_polys.R @@ -1,16 +1,16 @@ #' Group Polygons #' -#' Group individuals by polygon (eg: home ranges) overlap +#' Group individuals by polygon (home range) overlap #' #' #' @inheritParams group_pts #' @inheritParams group_lines #' @param area boolean indicating either returning area and proportion of overlap or group #' @param hrType type of HR estimation, of 'mcp' or 'kernel' -#' @param hrParams parameters for adehabitatHR functions, a named list passed to do.call +#' @param hrParams parameters for `adehabitatHR` functions, a named list passed to do.call #' @param spPolys Alternatively, provide solely a SpatialPolygons object. #' -#' @return If area is FALSE, a DT is returned with ID and spatialtemporal group. If area is TRUE, a DT is returned with ID and a proportional overlap. ID refers to the focal individual of which the total area is compared against the overlapping area of ID2. +#' @return If area is FALSE, a DT is returned with ID and spatial-temporal group. If area is TRUE, a DT is returned with ID and a proportional overlap. ID refers to the focal individual of which the total area is compared against the overlapping area of ID2. #' #' #' @export diff --git a/R/group_pts.R b/R/group_pts.R index 7b90fce0..d1b62f3e 100644 --- a/R/group_pts.R +++ b/R/group_pts.R @@ -2,7 +2,7 @@ #' #' Group points by spatial and temporal overlap. #' -#' This function finds spatialtemporal groups in input points. The threshold provided must be in the units of the projection of the coordinates. UTM coordinates (recommended) are in meters and threshold = 50 indicates a 50m threshold. +#' This function finds spatial-temporal groups in input points. The threshold provided must be in the units of the projection of the coordinates. UTM coordinates (recommended) are in meters and threshold = 50 indicates a 50m threshold. #' #' @param DT input data.table #' @param threshold for grouping points, in the units of the projection diff --git a/R/group_times.R b/R/group_times.R index 2dacd3c1..70bc8e61 100644 --- a/R/group_times.R +++ b/R/group_times.R @@ -2,13 +2,13 @@ #' #' Assign an integer timegroup. #' Provide the threshold to group on and rows will be grouped. -#' If the threshold is NULL, rows are grouped by matching exact datetimes. +#' If the threshold is NULL, rows are grouped by the `datetime` column directly. #' #' The threshold can be in units of minutes, hours or days. #' #' @inheritParams group_pts -#' @param datetime name of time column(s). either 1 POSIXct or 2 IDate and ITime. eg: 'datetime' or c('IDate', 'ITime') -#' @param threshold threshold for grouping times. eg: '2 hours', '10 minutes', etc. if not provided, times will be matched exactly. Note that provided threshold must be in the expected format: '## unit' +#' @param datetime name of time column(s). either 1 POSIXct or 2 IDate and ITime. e.g.: 'datetime' or c('IDate', 'ITime') +#' @param threshold threshold for grouping times. e.g.: '2 hours', '10 minutes', etc. if not provided, times will be matched exactly. Note that provided threshold must be in the expected format: '## unit' #' #' @export #' diff --git a/R/randomizations.R b/R/randomizations.R index 02d5a442..baecdb1e 100644 --- a/R/randomizations.R +++ b/R/randomizations.R @@ -13,7 +13,7 @@ #' @param DT input data.table with id, group fields and (optional) time fields #' @param type one of 'daily', 'step' or 'trajectory' - see details #' @param id field indicating the id in the input data.table -#' @param datetime (optional) time field used for providing datetime or hour field or group time field +#' @param datetime (optional) time field used for providing date time or hour field or timegroup field #' @inheritParams group_pts #' @param splitBy List of fields in DT to split the randomization process by #' @param iterations The number of iterations to randomize diff --git a/README.Rmd b/README.Rmd index 8dfbe5cd..ce7a7114 100644 --- a/README.Rmd +++ b/README.Rmd @@ -22,7 +22,7 @@ spatsoc is an R package for detecting spatial and temporal groups in GPS relocat See below for installation and basic usage. -For more detailed function descriptions, see the vignettes: +For more details, see the vignette: * [Introduction to spatsoc](https://spatsoc.gitlab.io/articles/intro-spatsoc.html) diff --git a/README.md b/README.md index 3d81393a..14f034cd 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ methods suitable for GPS data. See below for installation and basic usage. -For more detailed function descriptions, see the vignettes: +For more details, see the vignette: - [Introduction to spatsoc](https://spatsoc.gitlab.io/articles/intro-spatsoc.html) diff --git a/man/build_polys.Rd b/man/build_polys.Rd index f4b64a6b..0ecf2da2 100644 --- a/man/build_polys.Rd +++ b/man/build_polys.Rd @@ -15,7 +15,7 @@ build_polys(DT = NULL, projection = NULL, hrType = NULL, \item{hrType}{type of HR estimation, of 'mcp' or 'kernel'} -\item{hrParams}{parameters for adehabitatHR functions, a named list passed to do.call} +\item{hrParams}{parameters for \code{adehabitatHR} functions, a named list passed to do.call} \item{coords}{Character vector of X coordinate and Y coordinate column names} diff --git a/man/group_polys.Rd b/man/group_polys.Rd index 4eb79620..7502e3a5 100644 --- a/man/group_polys.Rd +++ b/man/group_polys.Rd @@ -15,7 +15,7 @@ group_polys(DT = NULL, area = NULL, hrType = NULL, hrParams = NULL, \item{hrType}{type of HR estimation, of 'mcp' or 'kernel'} -\item{hrParams}{parameters for adehabitatHR functions, a named list passed to do.call} +\item{hrParams}{parameters for \code{adehabitatHR} functions, a named list passed to do.call} \item{projection}{PROJ.4 character string} @@ -28,10 +28,10 @@ group_polys(DT = NULL, area = NULL, hrType = NULL, hrParams = NULL, \item{spPolys}{Alternatively, provide solely a SpatialPolygons object.} } \value{ -If area is FALSE, a DT is returned with ID and spatialtemporal group. If area is TRUE, a DT is returned with ID and a proportional overlap. ID refers to the focal individual of which the total area is compared against the overlapping area of ID2. +If area is FALSE, a DT is returned with ID and spatial-temporal group. If area is TRUE, a DT is returned with ID and a proportional overlap. ID refers to the focal individual of which the total area is compared against the overlapping area of ID2. } \description{ -Group individuals by polygon (eg: home ranges) overlap +Group individuals by polygon (home range) overlap } \examples{ library(data.table) diff --git a/man/group_pts.Rd b/man/group_pts.Rd index 0a590247..b1718a83 100644 --- a/man/group_pts.Rd +++ b/man/group_pts.Rd @@ -27,7 +27,7 @@ Input data.table with column 'group' added. Group points by spatial and temporal overlap. } \details{ -This function finds spatialtemporal groups in input points. The threshold provided must be in the units of the projection of the coordinates. UTM coordinates (recommended) are in meters and threshold = 50 indicates a 50m threshold. +This function finds spatial-temporal groups in input points. The threshold provided must be in the units of the projection of the coordinates. UTM coordinates (recommended) are in meters and threshold = 50 indicates a 50m threshold. } \examples{ library(data.table) diff --git a/man/group_times.Rd b/man/group_times.Rd index b6655dc8..a42f0888 100644 --- a/man/group_times.Rd +++ b/man/group_times.Rd @@ -9,14 +9,14 @@ group_times(DT = NULL, datetime = NULL, threshold = NULL) \arguments{ \item{DT}{input data.table} -\item{datetime}{name of time column(s). either 1 POSIXct or 2 IDate and ITime. eg: 'datetime' or c('IDate', 'ITime')} +\item{datetime}{name of time column(s). either 1 POSIXct or 2 IDate and ITime. e.g.: 'datetime' or c('IDate', 'ITime')} -\item{threshold}{threshold for grouping times. eg: '2 hours', '10 minutes', etc. if not provided, times will be matched exactly. Note that provided threshold must be in the expected format: '## unit'} +\item{threshold}{threshold for grouping times. e.g.: '2 hours', '10 minutes', etc. if not provided, times will be matched exactly. Note that provided threshold must be in the expected format: '## unit'} } \description{ Assign an integer timegroup. Provide the threshold to group on and rows will be grouped. -If the threshold is NULL, rows are grouped by matching exact datetimes. +If the threshold is NULL, rows are grouped by the \code{datetime} column directly. } \details{ The threshold can be in units of minutes, hours or days. diff --git a/man/randomizations.Rd b/man/randomizations.Rd index 94cccdd3..f2dc94e5 100644 --- a/man/randomizations.Rd +++ b/man/randomizations.Rd @@ -14,7 +14,7 @@ randomizations(DT = NULL, type = NULL, id = NULL, datetime = NULL, \item{id}{field indicating the id in the input data.table} -\item{datetime}{(optional) time field used for providing datetime or hour field or group time field} +\item{datetime}{(optional) time field used for providing date time or hour field or timegroup field} \item{splitBy}{List of fields in DT to split the randomization process by} diff --git a/vignettes/intro-spatsoc.Rmd b/vignettes/intro-spatsoc.Rmd index ebef7ccc..79769b6b 100644 --- a/vignettes/intro-spatsoc.Rmd +++ b/vignettes/intro-spatsoc.Rmd @@ -21,7 +21,7 @@ The `spatsoc` package provides functionality for analyzing animal relocation dat The package contains grouping functions that are used for identifying spatially and temporally explicit groups from input data. In addition, we provide a function for randomizing individual identifiers within groups, designed to test whether social networks generated from animal relocation data were based on non-random social proximity among individuals. -The functions were developped for application across animal relocation data, for example, proximity based social network analyses and spatial and temporal clustering of points. +The functions were developed for application across animal relocation data, for example, proximity based social network analyses and spatial and temporal clustering of points. ## Grouping Let's read in `spatsoc`'s example data.