From 8a2a5e06d956b755898ea65a06cd7a64c1635b05 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Mon, 25 Sep 2023 11:04:20 -0700 Subject: [PATCH] don't document arguments that aren't used --- R/engine_docs.R | 1 - R/hier_clust.R | 2 +- man/dot-hier_clust_fit_stats.Rd | 4 ++-- man/knit_engine_docs.Rd | 2 -- 4 files changed, 3 insertions(+), 6 deletions(-) diff --git a/R/engine_docs.R b/R/engine_docs.R index 4ebeddb8..0a8d37d6 100644 --- a/R/engine_docs.R +++ b/R/engine_docs.R @@ -3,7 +3,6 @@ #' Knit engine-specific documentation #' @param pattern A regular expression to specify which files to knit. The #' default knits all engine documentation files. -#' @param ... Options passed to [knitr::knit()]. #' @return A tibble with column `file` for the file name and `result` (a #' character vector that echos the output file name or, when there is #' a failure, the error message). diff --git a/R/hier_clust.R b/R/hier_clust.R index b85390a4..0fe09b04 100644 --- a/R/hier_clust.R +++ b/R/hier_clust.R @@ -171,7 +171,7 @@ translate_tidyclust.hier_clust <- function(x, engine = x$engine, ...) { #' #' @param x matrix or data frame #' @param num_clusters the number of clusters -#' @param h the height to cut the dendrogram +#' @param cut_height the height to cut the dendrogram #' @param linkage_method the agglomeration method to be used. This should be (an #' unambiguous abbreviation of) one of `"ward.D"`, `"ward.D2"`, `"single"`, #' `"complete"`, `"average"` (= UPGMA), `"mcquitty"` (= WPGMA), `"median"` (= diff --git a/man/dot-hier_clust_fit_stats.Rd b/man/dot-hier_clust_fit_stats.Rd index 0b735049..372e7cea 100644 --- a/man/dot-hier_clust_fit_stats.Rd +++ b/man/dot-hier_clust_fit_stats.Rd @@ -17,14 +17,14 @@ \item{num_clusters}{the number of clusters} +\item{cut_height}{the height to cut the dendrogram} + \item{linkage_method}{the agglomeration method to be used. This should be (an unambiguous abbreviation of) one of \code{"ward.D"}, \code{"ward.D2"}, \code{"single"}, \code{"complete"}, \code{"average"} (= UPGMA), \code{"mcquitty"} (= WPGMA), \code{"median"} (= WPGMC) or \code{"centroid"} (= UPGMC).} \item{dist_fun}{A distance function to use} - -\item{h}{the height to cut the dendrogram} } \value{ A dendrogram diff --git a/man/knit_engine_docs.Rd b/man/knit_engine_docs.Rd index 9aea6982..3315d0eb 100644 --- a/man/knit_engine_docs.Rd +++ b/man/knit_engine_docs.Rd @@ -9,8 +9,6 @@ knit_engine_docs(pattern = NULL) \arguments{ \item{pattern}{A regular expression to specify which files to knit. The default knits all engine documentation files.} - -\item{...}{Options passed to \code{\link[knitr:knit]{knitr::knit()}}.} } \value{ A tibble with column \code{file} for the file name and \code{result} (a