Skip to content

robust argument is still in the documentation despite renaming to ranktransform #344

@DominiqueMakowski

Description

@DominiqueMakowski

correlation/R/cor_test.R

Lines 41 to 48 in 9e2503b

#' @param ranktransform If `TRUE`, will rank-transform the variables prior to
#' estimating the correlation, which is one way of making the analysis more
#' resistant to extreme values (outliers). Note that, for instance, a
#' Pearson's correlation on rank-transformed data is equivalent to a
#' Spearman's rank correlation. Thus, using `robust=TRUE` and
#' `method="spearman"` is redundant. Nonetheless, it is an easy option to
#' increase the robustness of the correlation as well as flexible way to
#' obtain Bayesian or multilevel Spearman-like rank correlations.

We still refer to robust in the documentation, despite that this argument has been expanded and is now more specific (ranktransform and winsorize). Need to remove mentions of robust in favour of ranktransform

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions