pedometrics (version 0.7.0)

cdfTable: Table with descriptive statistics of an estimated cumulative distribution function

Description

This function returns a table containing the descriptive statistics of the cumulative distribution function of a set of continuous variables. TeX code is printed to copy and paste in a document.

Usage

cdfTable(x, type = "xy", rounding = 0, tex = FALSE, data.frame = FALSE)

Arguments

x

Object with the estimated cumulative distribution function of the set of continuous variables. The resulting object of cont.analysis() of spsurvey-package.

type

Type of data under analysis. Defaults to type = "xy". See ‘Details’.

rounding

Rounding level of the data in the output table. Defaults to rounding = 0.

tex

Logical for creating TeX code. Defaults to tex = FALSE.

data.frame

Logical for returning a data.frame object. Defaults to data.frame = FALSE.

Value

Returned value depends on how arguments type and tex are set.

list("type")

If type = "xy", then the function returns a table with estimated population mean and standard deviation of error statistics for ‘x’ and ‘y’ coordinates. These error statistics include the mean error, mean absolute error, and mean square error. It also returns the estimated mean and mean square error vector (module), and the estimated mean azimuth. The number of ground control points used to make the estimates is printed by default.

If type = "z", then the function returns a table with estimated population mean and standard deviation of error statistics for ‘z’, the attribute under analysis. These error statistics include the mean error, mean absolute error, and mean square error. The number of ground control points used to make the estimates is printed by default.

list("tex")

If tex = TRUE, them the function prints the TeX code for the table defined by the argument type. Otherwise the TeX code is not generated.

Details

Summary statistics included in the table (estimated population mean and standard deviation) are obtained from the resulting object of cont.analysis() by internally using the function cdfStats().

There are two types of data that can be submitted to function cdfTable(). The first (type = "xy") is composed by two instances (‘x’ and ‘y’) and is produced during horizontal (positional) validation exercises (validation in the geographic space). Thus, ‘x’ and ‘y’ represent, respectively, the horizontal displacement (error) in ‘x’ and ‘y’ coordinates.

The second type of data (type = "z") is composed by only one instance (‘z’) and is generated by vertical validation exercises (validation in the attribute space). Thus, ‘z’ represents the vertical displacement (error) of the attribute ‘z’ being measured.

References

Kincaid, T. M. and Olsen, A. R. (2013). spsurvey: Spatial Survey Design and Analysis. R package version 2.6. URL: http://www.epa.gov/nheerl/arm/.

See Also

cdfStats, cont.analysis.

Examples

# NOT RUN {
# }
# NOT RUN {
if (require(spsurvey)) {
## Estimate the CDF
my.cdf <- spsurvey::cont.analysis(spsurvey.obj = my.spsurvey)

## Print table and TeX code
cdfTable(my.cdf)
}
# }
# NOT RUN {
# }