ena.writeup: Calculate the correlations

Description Usage Arguments Value

View source: R/ena.writeup.R

Description

Calculate both Spearman and Pearson correlations for the provided ENAset

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
ena.writeup(
  enaset,
  tool = "rENA",
  tool.version = as.character(packageVersion(tool)),
  comparison = NULL,
  comparison.groups = NULL,
  sig.dig = 2,
  output_dir = getwd(),
  type = c("file", "stream"),
  theory = T,
  methods = T,
  params = NULL,
  output_file = NULL
)

Arguments

enaset

ENAset to view methods of

tool

c("rENA","webENA")

tool.version

as.character(packageVersion(tool))

comparison

character string representing the comparison used, c(NULL, "parametric", "non-parametric"). Default NULL

comparison.groups

Groups that were used for the comparison

sig.dig

Integer for the number of digits to round to

output_dir

Where to save the output file

type

c("file","stream") File will save to a file in output_dir, Stream returns the contents directly

theory

Logical indicating whether to include theory in the writeup

methods

Logical indicating whether to include methods in the writeup

params

additional parameters for rmarkdown::render

output_file

character

Value

String representing the methods used to generate the model


rENA documentation built on April 23, 2021, 5:06 p.m.