spelling

ropensci · Jul 24, 2018 · 92083ad · 92083ad
1 parent bc5f927
commit 92083ad
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 20 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/man/group_polys.Rd b/man/group_polys.Rd
diff --git a/man/group_pts.Rd b/man/group_pts.Rd
diff --git a/man/group_times.Rd b/man/group_times.Rd
diff --git a/man/randomizations.Rd b/man/randomizations.Rd
diff --git 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, the package contains functions for determining the nearest neighbor and mean pairwise distance between individuals, optionally across time steps.--> 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.