traitdataform (version 0.6.8)

as.trait: Create a trait definition

Description

Creating an object containing a standardised trait definition according to the Ecological Traitdata Standard. Parameters correspond to the definition at https://ecologicaltraitdata.github.io/ETS/#terms-for-trait-definitions.

Usage

as.trait(
  trait,
  identifier = NA,
  broaderTerm = NA,
  narrowerTerm = NA,
  relatedTerm = NA,
  valueType = NA,
  expectedUnit = NA,
  factorLevels = NA,
  replaceFactorLevels = NA,
  maxAllowedValue = NA,
  minAllowedValue = NA,
  traitDescription = NA,
  comments = NA,
  source = NA,
  version = NA,
  author = NA,
  ...
)

Arguments

trait

A character string, providing an intuitive, human-readable trait name.

identifier

Unique identifier for the trait, ideally unique and stable URI which identify the source of the trait definition.

broaderTerm

One or several terms that enclose the trait definition.

narrowerTerm

One or several terms that are enclosed by the trait definition.

relatedTerm

One or several terms that are related to this term (ideally given as URI).

valueType

the type of trait values. Possible entries are 'numeric', 'integer', 'categorical', 'logical', or 'character'.

expectedUnit

the unit expected for measurement entries.

factorLevels

A comma separated list of terms comprising the constrained vocabulary for categorical traits or ordinal binary traits.

replaceFactorLevels

A list or vector containing synonymous factor levels to be mapped onto the target factor levels provided in 'factorLevels'. Names of the vector or list entries will be superimposed by entries in 'factorLevels'.

maxAllowedValue

An upper boundary for accepted numerical values.

minAllowedValue

A lower boundary for accepted numerical values.

traitDescription

A short, unambiguous definition of the trait. May refer to a method of measurement.

comments

Details and Examples for clarification of the trait definition.

source

A character string providing a full bibliographic reference to the trait definition (giving title, author, year and publication).

version

A character string containing the version number of the referenced definition (e.g. "v1.2"), if applicable.

author

A character string or object of class 'person' (as created by as.person()) attributing the author(s) of the trait definition.

...

other arguments, passed on to print function.

Value

A structured data.frame object of class 'trait'.

Examples

# NOT RUN {
body_length <- as.trait("body_length", expectedUnit = "mm", valueType = "numeric",
  identifier = "http://t-sita.cesab.org/BETSI_vizInfo.jsp?trait=Body_length",
  traitDescription = "The known longest dimension of the physical structure of organisms",
  relationSource = "Maggenti and Maggenti, 2005",
  broaderTerm = "http://t-sita.cesab.org/BETSI_vizInfo.jsp?trait=Body_dimension"
  )

# }