From 8352bc8ebf63b0f5bd799339545ea4270258c08e Mon Sep 17 00:00:00 2001 From: Daniel Date: Thu, 26 Oct 2023 14:24:32 +0200 Subject: [PATCH] docs --- R/n_factors.R | 6 ++---- man/n_factors.Rd | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/R/n_factors.R b/R/n_factors.R index c60cbf02a..5231fadba 100644 --- a/R/n_factors.R +++ b/R/n_factors.R @@ -7,8 +7,7 @@ #' with the fewer factors. #' #' @param x A data frame. -#' @param type Can be `"FA"` or `"PCA"`, depending on what you want to -#' do. +#' @param type Can be `"FA"` or `"PCA"`, depending on what you want to do. #' @param rotation Only used for VSS (Very Simple Structure criterion, see #' [psych::VSS()]). The rotation to apply. Can be `"none"`, `"varimax"`, #' `"quartimax"`, `"bentlerT"`, `"equamax"`, `"varimin"`, `"geominT"` and @@ -43,8 +42,7 @@ #' #' @note There is also a #' [`plot()`-method](https://easystats.github.io/see/articles/parameters.html) -#' implemented in the -#' [**see**-package](https://easystats.github.io/see/). +#' implemented in the [**see**-package](https://easystats.github.io/see/). #' `n_components()` is a convenient short-cut for `n_factors(type = "PCA")`. #' #' @examplesIf require("PCDimension", quietly = TRUE) && require("nFactors", quietly = TRUE) diff --git a/man/n_factors.Rd b/man/n_factors.Rd index b39ea62cb..a2c99261e 100644 --- a/man/n_factors.Rd +++ b/man/n_factors.Rd @@ -31,8 +31,7 @@ n_components( \arguments{ \item{x}{A data frame.} -\item{type}{Can be \code{"FA"} or \code{"PCA"}, depending on what you want to -do.} +\item{type}{Can be \code{"FA"} or \code{"PCA"}, depending on what you want to do.} \item{rotation}{Only used for VSS (Very Simple Structure criterion, see \code{\link[psych:VSS]{psych::VSS()}}). The rotation to apply. Can be \code{"none"}, \code{"varimax"}, @@ -86,8 +85,7 @@ different defaults for the function arguments. \note{ There is also a \href{https://easystats.github.io/see/articles/parameters.html}{\code{plot()}-method} -implemented in the -\href{https://easystats.github.io/see/}{\strong{see}-package}. +implemented in the \href{https://easystats.github.io/see/}{\strong{see}-package}. \code{n_components()} is a convenient short-cut for \code{n_factors(type = "PCA")}. } \examples{