mefaCheck: Check and Compare Object(s) of Class 'mefa'

Description Usage Arguments Value Author(s) References See Also Examples

Description

The functions evaluates the internal structute of a 'mefa' object.

Usage

1
2
mefaCheck(x)
mefaCompare(x1, x2, strict = FALSE)

Arguments

x, x1, x2

an object of class 'mefa'.

strict

logical, if TRUE the function checks if ordering of dimnames are the same, otherwise it compares only matching.

Value

mefaCheck returns a list, first element is logical with TRUE indicating that all requirements are met. If this is FALSE, following elements of the list describe the encountered problems as characters. mefaCheck is called by the is.mefa function.

mefaCompare compares two mefa objects. If all dimnames, and the corresponding values in the xtab and segm parts are identical, the result is TRUE, and otherwise FALSE. Different ordering of dimnames allowed, the comparison is based on the numeric values determined by dimnames.

Author(s)

P\'eter S\'olymos, solymos@ualberta.ca

References

S\'olymos P. (2008) mefa: an R package for handling and reporting count data. Community Ecology 9, 125–127.

S\'olymos P. (2009) Processing ecological data in R with the mefa package. Journal of Statistical Software 29(8), 1–28. doi: 10.18637/jss.v029.i08

http://mefa.r-forge.r-project.org/

See Also

mefa, is.mefa, all.equal.list

Examples

1
2
3
4
5
6
7
8
x <- matrix(rpois(20,1), 5, 4)
m <- mefa(x)
mefaCheck(m)
data(dol.count)
x1 <- mefa(stcs(dol.count))
x2 <- mefa(melt(x1))
mefaCompare(x1, x2)
mefaCompare(x1, x2, strict = TRUE)

mefa documentation built on Oct. 7, 2021, 9:11 a.m.

Related to mefaCheck in mefa...