ftest_write: Record the significance of different variables of a...

Description Usage Arguments Details Value Examples

View source: R/fexport.R

Description

Record in a file the results of a test of significance of functional clustering.

Usage

1
2
ftest_write(fres, rtest, filename,
            opt.var = c("components", "assemblages", "performances") )

Arguments

fres

an object resulting from a functional clustering obtained with the whole dataset using the function fclust.

rtest

a list of matrices, each matrix containing the results for a given clustering index. The object rtest is generated by the function ftest.

filename

a string, used as radical for naming the file "filename.components.csv", "filemane.assemblages.csv" or "filemane.performances.csv" according to the dimensions of matrices.

opt.var

a string, specifying the last part of the file-name. opt can only be equal to "components", "assemblages" or "performances".

Details

The functions ftest, ftest_components, ftest_assemblages and ftest_performances generate a list containing a matrix by clustering index ("Czekanowski_Dice", "Folkes_Mallows", "Jaccard", "Kulczynski", "Precision", "Rand", "Recall", "Rogers_Tanimoto", "Russel_Rao", "Sokal_Sneath1" and "Sokal_Sneath2" index). Only their dimensions change according the used functions. Consequently, a same function is used for recording and reading the results of both the test-functions.

Value

Nothing. It is a procedure.

Examples

1
2
3
4
5
6
# save "rtest" in the file "myRecord.*".

ftest_write(fres  = CedarCreek.2004.2006.res,
            rtest = CedarCreek.2004.2006.test.components,
            filename = tempfile(pattern = "myRecord", tmpdir = tempdir()),
            opt.var  = "components")

functClust documentation built on Dec. 2, 2020, 5:06 p.m.