ejscreensignifarray: Specify Significant Digits for Each Column of EJSCREEN...

View source: R/ejscreensignifarray.R

ejscreensignifarrayR Documentation

Specify Significant Digits for Each Column of EJSCREEN Indicators

Description

Given a matrix or numeric data.frame, round each column to a specified column-specific number of significant digits. This function provides default values significant digits to use for an EJSCREEN environmental dataset. This is a wrapper for analyze.stuff::signifarray which is a wrapper that applies signif() to a matrix or data.frame.

Usage

ejscreensignifarray(dat, digits = "ejscreen")

Arguments

dat

Required, matrix or numeric data.frame with the values to be rounded.

digits

Optional, 'ejscreen' by default. Can be a vector as long as the number of columns in dat, where each elements specifies the number of significant digits to retain for numbers in the corresponding column of dat. If 'ejscreen' it specifies using the default settings described below in details, in which case all colnames(dat) must be among (but in any order) defaultcolnames below.

Details

Sig figs used if digits specified as 'ejscreen' are those stored in data(esigfigs)

Value

Returns dat, but with numbers rounded based on digits parameter.

See Also

esigfigs analyze.stuff::signifarray() signif


ejanalysis/ejscreen documentation built on Jan. 1, 2025, 10:04 a.m.