get_metadata_json() gives a frame's metadata as JSON, which any language
can read. set_metadata_json() restores metadata from that JSON, so that
the round trip gives back exactly what get_metadata() gave.
This is how the metadata travels outside R, for instance in the key-value metadata of a Parquet file written by aniread.
Arguments
- data
An aniframe. For
set_metadata_json(), a frame of the class the metadata belongs to: its class decides which categories and slots are valid.- json
A JSON string from
get_metadata_json(). Or that JSON already parsed withjsonlite::fromJSON(simplifyVector = FALSE), for when it is embedded in a larger document.
Layout
The JSON has the categories of list_default_metadata() as objects, in
the same order, with spec_version saying which version of the layout it
follows:
A field with a fixed set of values (
unit_time,unit_space,coordinate_system, ...) is its value as a string.NAisnull.source_sampling_ratecan also be the string"NaN": a device with no fixed rate, which JSON has no number for.start_datetimeis an ISO 8601 time in UTC, to the microsecond, with its time zone beside it asstart_timezone(an IANA name, or""for the session's own).axis_directionsandaxis_extentsare objects from axis role to value.In
variables, each role is an object of slots. A slot that maps axis roles to columns (where$position) is an object; one that lists columns (what$keys) is an array, even with one column.structureis an object of structures. Each haspoints(an array),segmentsandjoints(arrays of row objects), androot,source,citation,licenseandvariable.
Numbers are written with as few digits as read back exactly. Inf and
-Inf, which JSON also has no number for, are strings like "NaN".
Examples
x <- example_anipoint(n_obs = 2, n_individuals = 1)
json <- get_metadata_json(x)
json
#> [1] "{\"spec_version\":{\"aniframe\":\"3.0.0\",\"anievent\":\"1.0.0\"},\"recording\":{\"source\":null,\"source_version\":null,\"source_format\":null,\"source_sampling_rate\":null,\"filename\":null},\"time\":{\"unit_time\":\"frame\",\"sampling_rate\":null,\"sampling_interval\":1,\"start_datetime\":null,\"start_timezone\":\"\"},\"space\":{\"coordinate_system\":\"cartesian_2d\",\"reference_frame\":\"allocentric\",\"handedness\":\"unknown\",\"axis_directions\":{},\"axis_extents\":{},\"unit_space\":\"px\",\"unit_angle\":\"rad\",\"euler_sequence\":null,\"euler_intrinsic\":null},\"variables\":{\"what\":{\"keys\":[\"individual\",\"keypoint\"]},\"when\":{\"index\":[\"time\"],\"keys\":[\"session\",\"trial\"]},\"where\":{\"position\":{\"x\":\"x\",\"y\":\"y\"}},\"event\":{\"state\":[],\"point\":[]}},\"structure\":{}}"
y <- set_metadata_json(x, json)
identical(get_metadata(y), get_metadata(x))
#> [1] TRUE