FFTrees (version 1.4.0)

inwords: Describes an FFT in words

Description

Describes an FFT in words

Usage

inwords(x = NULL, tree = NULL, classes.v = NULL, cues.v = NULL,
  directions.v = NULL, thresholds.v = NULL, exits.v = NULL,
  decision.labels = NULL, digits = 2, version = 1)

Arguments

x

FFTrees. An FFTrees object created with FFTrees()

tree

integer. An integer specifying which tree in the object to verbalise. The default is x$tree.max

classes.v

integer.

cues.v

integer.

directions.v

string.

thresholds.v

string.

exits.v

numeric.

decision.labels

string. A string vector (of length 2) indicating labels for negative (0 or FALSE) and positive (1 or TRUE) cases in the crterion

digits

integer. How many digits to round numeric values

version

integer. Which version to show? 1 or 2

Value

A list of string vectors

Examples

# NOT RUN {
heart.fft <- FFTrees(diagnosis ~.,
                     data = heartdisease,
                     decision.labels = c("Healthy", "Disease"))

inwords(heart.fft)

# }