Field: one column or attribute of a record set

Usage

Field(
  id = NULL,
  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
)

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, as compact IRIs such as "sc:Text" or "sc:Integer".
source: Optional Source object: Where the values come from.
references: Optional Source object: The field this field joins to.
sub_field: Optional List: Field objects nested in this field.
parent_field: Optional ParentField object.
annotation: Optional List: Field objects that annotate this field.
repeated: Optional Logical: Whether the field holds a list of values.
is_array: Optional Logical: Whether the field holds an array.
array_shape: Optional Character: Array shape, such as "28,28".
equivalent_property: Optional Character: IRIs of properties equivalent to this field, such as "prov:wasDerivedFrom".
value: Optional: Constant value of the field, any JSON value.
other_properties: Optional List: Properties without a typed counterpart, keyed by canonical JSON-LD key, with their parsed JSON values.

Value

Field object.

Author

EDG

Examples

Field(
  id = "passengers/name",
  name = "name",
  data_type = "sc:Text",
  source = Source(file_object = "passengers.csv", extract = Extract(column = "name"))
)

#> <croissant::Field>
#>  @ id                 : chr "passengers/name"
#>  @ name               : chr "name"
#>  @ description        : NULL
#>  @ data_type          : chr "sc:Text"
#>  @ source             : <croissant::Source>
#>  .. @ file_object     : chr "passengers.csv"
#>  .. @ file_set        : NULL
#>  .. @ record_set      : NULL
#>  .. @ field           : NULL
#>  .. @ extract         : <croissant::Extract>
#>  .. .. @ column          : chr "name"
#>  .. .. @ file_property   : NULL
#>  .. .. @ json_path       : NULL
#>  .. .. @ other_properties: NULL
#>  .. @ transform       : NULL
#>  .. @ format          : NULL
#>  .. @ sampling_rate   : NULL
#>  .. @ other_properties: 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