From: Benjamin Auder Date: Fri, 17 Mar 2017 15:15:04 +0000 (+0100) Subject: [cosmetics] Slight improvements in doc X-Git-Url: https://git.auder.net/doc/html/pieces/img/%7B%7B?a=commitdiff_plain;h=14c10f2d252f45349e0b4fbf87e17dfbfae39f92;p=epclust.git [cosmetics] Slight improvements in doc --- diff --git a/epclust/R/computeWerDists.R b/epclust/R/computeWerDists.R index 5f12896..0ad5404 100644 --- a/epclust/R/computeWerDists.R +++ b/epclust/R/computeWerDists.R @@ -3,8 +3,8 @@ #' Compute the WER distances between the series at specified indices, which are #' obtaind by \code{getSeries(indices)} #' -#' @param indices Range of series indices to cluster -#' @param getSeries Function to retrieve series (argument: 'indices', integer vector), +#' @param indices Indices of the series to consider +#' @param getSeries Function to retrieve series (argument: 'inds', integer vector), #' as columns of a matrix #' @param ncores Number of cores for parallel runs #' @inheritParams claws diff --git a/epclust/R/main.R b/epclust/R/main.R index b6eb511..09e1ed7 100644 --- a/epclust/R/main.R +++ b/epclust/R/main.R @@ -62,7 +62,7 @@ #' @param nvoice Number of voices within each octave for CWT computations #' @param random TRUE (default) for random chunks repartition #' @param ntasks Number of tasks (parallel iterations to obtain K1 [if WER=="end"] -#' or K2 [if WER=="mix"] medoids); default: 1. +#' or K2 [if WER=="mix"] medoids); default: 1.\cr #' Note: ntasks << N (number of series), so that N is "roughly divisible" by ntasks #' @param ncores_tasks Number of parallel tasks ('1' == sequential tasks) #' @param ncores_clust Number of parallel clusterings in one task