From 0e431ce852867efa327280504af14932695ecdd9 Mon Sep 17 00:00:00 2001 From: "Adam B. Smith" Date: Fri, 8 Nov 2024 09:55:18 -0600 Subject: [PATCH] Update help --- R/geoFold.r | 2 +- man/geoFold.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/geoFold.r b/R/geoFold.r index b5f4685..615c796 100644 --- a/R/geoFold.r +++ b/R/geoFold.r @@ -20,7 +20,7 @@ #' @param k Numeric: Number of folds to create. #' @param minIn Numeric: Minimum number of points required to be in a fold. #' @param longLat Character or integer vector: This is ignored if \code{x} is a \code{SpatVector} or \code{sf} object. However, if \code{x} is a \code{data.frame} or \code{matrix}, then this should be a character or integer vector specifying the columns in \code{x} corresponding to longitude and latitude (in that order). For example, \code{c('long', 'lat')} or \code{c(1, 2)}. The default is to assume that the first two columns in \code{x} represent coordinates. -#' @param method Character: Method used by \code{\link[stats]{hclust}} to cluster points. By default, this is \code{'single'}, but in some cases this may result in strange clustering (especially when there is a large number of points). The \code{'complete'} method (or others) may give more reasonable results in these cases. +#' @param method Character: Method used by \code{\link[stats]{hclust}} to cluster points. By default, this is \code{'complete'}, but other methods may give more reasonable results, depending on the case. #' @param ... Additional arguments (unused) #' #' @return A vector of integers the same length as the number of points in \code{x}. Each integer indicates which fold a point in \code{x} belongs to. diff --git a/man/geoFold.Rd b/man/geoFold.Rd index dddc14f..f2a6ac4 100644 --- a/man/geoFold.Rd +++ b/man/geoFold.Rd @@ -15,7 +15,7 @@ geoFold(x, k, minIn = 1, longLat = 1:2, method = "complete", ...) \item{longLat}{Character or integer vector: This is ignored if \code{x} is a \code{SpatVector} or \code{sf} object. However, if \code{x} is a \code{data.frame} or \code{matrix}, then this should be a character or integer vector specifying the columns in \code{x} corresponding to longitude and latitude (in that order). For example, \code{c('long', 'lat')} or \code{c(1, 2)}. The default is to assume that the first two columns in \code{x} represent coordinates.} -\item{method}{Character: Method used by \code{\link[stats]{hclust}} to cluster points. By default, this is \code{'single'}, but in some cases this may result in strange clustering (especially when there is a large number of points). The \code{'complete'} method (or others) may give more reasonable results in these cases.} +\item{method}{Character: Method used by \code{\link[stats]{hclust}} to cluster points. By default, this is \code{'complete'}, but other methods may give more reasonable results, depending on the case.} \item{...}{Additional arguments (unused)} }