Surface type definition

defineSurfaceTypes(
  name,
  description,
  surfaceNames,
  definitions = NULL,
  citationString = "",
  DOI = ""
)

Arguments

name: A string to identify the surface type definition.
description: A string describing how surface types are defined.
surfaceNames: A character vector of names for surface types.
definitions: A character vector of definition of surface types.
citationString: A string with the bibliographic reference for the method.
DOI: A string with the DOI of a resource describing the method.

Value

an object of class VegXSurfaceTypeDefinition

Examples


defineSurfaceTypes(name = "Default Surface types",
                   description = "Five simple surface categories",
                   surfaceNames = c("Vegetation", "Moss", "Litter", "Exposed Soil", "Rock"))
#> An object of class "VegXSurfaceTypeDefinition"
#> Slot "method":
#> An object of class "VegXMethodDefinition"
#> Slot "name":
#> [1] "Default Surface types"
#> 
#> Slot "description":
#> [1] "Five simple surface categories"
#> 
#> Slot "citationString":
#> [1] ""
#> 
#> Slot "DOI":
#> [1] ""
#> 
#> Slot "subject":
#> [1] "surface category"
#> 
#> Slot "attributeType":
#> [1] "qualitative"
#> 
#> Slot "attributes":
#> list()
#> 
#> 
#> Slot "surfaceTypes":
#> $`1`
#> $`1`$surfaceNames
#> [1] "Vegetation"
#> 
#> 
#> $`2`
#> $`2`$surfaceNames
#> [1] "Moss"
#> 
#> 
#> $`3`
#> $`3`$surfaceNames
#> [1] "Litter"
#> 
#> 
#> $`4`
#> $`4`$surfaceNames
#> [1] "Exposed Soil"
#> 
#> 
#> $`5`
#> $`5`$surfaceNames
#> [1] "Rock"
#> 
#> 
#>