envalysis (version 0.3.3)

signifig: Print significant figures

Description

This function reports the significant figures of a given mean together with its respective error term (e.g. confidence interval or standard deviation).

Usage

signifig(mean, error, data, signif.na = 2, style = "pm")

Arguments

mean

a numeric vector or data frame object containing the averaged values

error

a numeric vector or data frame object containing the respective error terms

data

a data frame containing the specified columns. If empty, mean and error need to be given as numeric vectors

signif.na

an integer controlling to which significant digit the mean value should be rounded when no error data was given

style

a string specifying the output style to be used. The default style "pm" reports the results as "3 <U+00B1> 6", while "par" results in outputs like "0.26 (0.02)". "siunitx" returns "0.26 (2)" which might be used together with xtable for automated LaTeX table outputs.

References

Taylor, J.R., 1997. Error analysis: the study of uncertainties in physical measurements. University Science Books, Sausalito, CA.

Examples

# NOT RUN {
signifig(mean = c(0.28,5), error = c(0.688, 8))

# }