RecordSet: a set of records with a common structure

Usage

RecordSet(
  id = NULL,
  name = NULL,
  description = NULL,
  data_type = NULL,
  key = NULL,
  field = NULL,
  annotation = NULL,
  data = NULL,
  examples = NULL,
  other_properties = NULL
)

Arguments

id: Optional Character: @id, unique within the document.
name: Optional Character: Name, or a character vector named by language tag.
description: Optional Character: Description, or a character vector named by language tag.
data_type: Optional Character: Data types, such as "sc:Enumeration".
key: Optional Character: @id of each field that forms the record key.
field: Optional List: Field objects.
annotation: Optional List: Field objects that annotate the record set.
data: Optional List: Records given inline, as parsed JSON.
examples: Optional List: Example records, as parsed JSON.
other_properties: Optional List: Properties without a typed counterpart, keyed by canonical JSON-LD key, with their parsed JSON values.

Value

RecordSet object.

Author

EDG

Examples

RecordSet(id = "passengers", name = "passengers", field = list(Field(id = "passengers/name")))

#> <croissant::RecordSet>
#>  @ id              : chr "passengers"
#>  @ name            : chr "passengers"
#>  @ description     : NULL
#>  @ data_type       : NULL
#>  @ key             : NULL
#>  @ field           :List of 1
#>  .. $ : <croissant::Field>
#>  ..  ..@ id                 : chr "passengers/name"
#>  ..  ..@ name               : NULL
#>  ..  ..@ description        : NULL
#>  ..  ..@ data_type          : NULL
#>  ..  ..@ source             : NULL
#>  ..  ..@ references         : NULL
#>  ..  ..@ sub_field          : NULL
#>  ..  ..@ parent_field       : NULL
#>  ..  ..@ annotation         : NULL
#>  ..  ..@ repeated           : NULL
#>  ..  ..@ is_array           : NULL
#>  ..  ..@ array_shape        : NULL
#>  ..  ..@ equivalent_property: NULL
#>  ..  ..@ value              : NULL
#>  ..  ..@ other_properties   : NULL
#>  @ annotation      : NULL
#>  @ data            : NULL
#>  @ examples        : NULL
#>  @ other_properties: NULL