create_interval_ratio: Create an attribute in Interval or Ratio Measurement Scales

View source: R/attribute-element.R

create_interval_ratioR Documentation

Create an attribute in Interval or Ratio Measurement Scales

Description

Create an attribute in Interval or Ratio Measurement Scales

Usage

create_interval_ratio(
  type = c("interval", "ratio"),
  units,
  number_type,
  unit_precision = NULL,
  minimum = NULL,
  maximum = NULL
)

Arguments

type

Either "interval" or "ratio". Use "interval" to define data which consist of equidistant points on a scale. Use "ratio" to define data which consists not only of equidistant points but also has a meaningful zero point, which allows the ratio to have meaning.

units

The units assigned to this attribute.

number_type

What type of number. Examples given in exported documentation.

unit_precision

How precise this attirbutes' measurements are recorded.

minimum

Optional. Theoretical or allowable minimum value. Values can be larger than or equal to this number.

maximum

Optional. Theoretical or allowable maximum value. Values can be less than or equal to this number.

Examples

# Interval:
## Not run: create_attribute(attribute_name = "Count",
                          attribute_definition = "Number of individuals observed",
                          measurement_scale = EMLaide::measurement_scale$interval, 
                          type = "interval",
                          units = "number",
                          unit_precision = "1",
                          number_type = EMLaide::number_type$whole, 
                          minimum = "0")
## End(Not run)
                   
# Ratio: 
## Not run: create_attribute(attribute_name = "pH",
                          attribute_definition = "pH of soil solution",
                          measurement_scale = EMLaide::measurement_scale$ratio,
                          type = "ratio",
                          units = "dimensionless",
                          unit_precision = "0.01",
                          number_type = EMLaide::number_type$real)
## End(Not run)

CVPIA-OSC/EMLaide documentation built on Aug. 25, 2023, 8:53 a.m.