From 47af690e6f818956d5e0fa8dd680a42919196fb7 Mon Sep 17 00:00:00 2001 From: DAPPERstats Date: Thu, 7 Jan 2021 15:42:04 -0800 Subject: [PATCH] docs --- R/utilities.R | 7 ++++--- man/overlap.Rd | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/R/utilities.R b/R/utilities.R index 9f61d18..96407fb 100644 --- a/R/utilities.R +++ b/R/utilities.R @@ -4,8 +4,8 @@ #' @title Measure overlap between pairs of CDFs #' #' @description Measures overlap between pairs of CDFs. First uses -#' \code{\link[pracma]{numdiff}} to differentiated the CDFs, then calculates -#' the classic Overlap Coefficient. +#' \code{numdiff} (\code{\link[pracma]{numderiv}}) to differentiate the CDFs, +#' then calculates the classic Overlap Coefficient. #' #' @param Fs \code{list} of CDFs #' @@ -14,7 +14,8 @@ #' #' @param digits rounding digits #' -#' @param ... additional arguments to pass to \code{\link[pracma]{numdiff}} +#' @param ... additional arguments to pass to \code{numdiff} +#' (\code{\link[pracma]{numderiv}}) #' #' @return \code{matrix} of pairwise overlap values #' diff --git a/man/overlap.Rd b/man/overlap.Rd index d6ec73d..bc34eac 100644 --- a/man/overlap.Rd +++ b/man/overlap.Rd @@ -14,13 +14,14 @@ differentiated} \item{digits}{rounding digits} -\item{...}{additional arguments to pass to \code{\link[pracma]{numdiff}}} +\item{...}{additional arguments to pass to \code{numdiff} +(\code{\link[pracma]{numderiv}})} } \value{ \code{matrix} of pairwise overlap values } \description{ Measures overlap between pairs of CDFs. First uses - \code{\link[pracma]{numdiff}} to differentiated the CDFs, then calculates - the classic Overlap Coefficient. + \code{numdiff} (\code{\link[pracma]{numderiv}}) to differentiate the CDFs, + then calculates the classic Overlap Coefficient. }