Skip to contents

Make starred correlations table output object of multiple potential types

Source: R/fn_make.R
make_corstars_tbl_xx.Rd

make_corstars_tbl_xx() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make starred correlations table output object of multiple potential types. The function is called for its side effects and does not return a value.

Usage

make_corstars_tbl_xx(
  x,
  caption_1L_chr = NULL,
  mkdn_tbl_ref_1L_chr = NULL,
  method_chr = c("pearson", "spearman"),
  removeTriangle_chr = c("upper", "lower"),
  result_chr = "none"
)

Arguments

x

An object

caption_1L_chr

Caption (a character vector of length one), Default: NULL

mkdn_tbl_ref_1L_chr

Markdown table reference (a character vector of length one), Default: NULL

method_chr

Method (a character vector), Default: c("pearson", "spearman")

removeTriangle_chr

RemoveTriangle (a character vector), Default: c("upper", "lower")

result_chr

Result (a character vector), Default: 'none'

Value

No return value, called for side effects.