loadConstraints is a data loading function for creating a constraints object. loadConstraints can read constraints from a data.frame or a .csv file. The contents must be in the expected format; see the vignette in vignette("constraints") for a documentation.

loadConstraints(object, pool, item_attrib, st_attrib = NULL)

Arguments

object

constraint specifications. Can be a data.frame or the file path of a .csv file. See the vignette for a description of the expected format.

pool

an item_pool object. Use loadItemPool for this.

item_attrib

an item_attrib object. Use loadItemAttrib for this.

st_attrib

(optional) an st_attrib object. Use loadStAttrib for this.

Value

loadConstraints returns a constraints object. This object is used in Static and Shadow.

Examples

## Read from data.frame:
itempool_science    <- loadItemPool(itempool_science_data)
itemattrib_science  <- loadItemAttrib(itemattrib_science_data, itempool_science)
constraints_science <- loadConstraints(constraints_science_data,
  itempool_science, itemattrib_science)

## Read from file: write to tempdir() for illustration and clean afterwards
f <- file.path(tempdir(), "constraints_science.csv")
write.csv(constraints_science_data, f, row.names = FALSE)
constraints_science <- loadConstraints(f,
  itempool_science, itemattrib_science)
file.remove(f)
#> [1] TRUE