Function to populate hdf5 file with array type data.
write_array(
array,
handle,
data_product,
component,
description,
dimension_names,
dimension_values,
dimension_units,
units
)Returns a handle index associated with the just written component, which can be used to raise an issue if necessary
an array containing the data
an object of class fdp, R6 containing metadata required
by the Data Pipeline API
a string specifying the name of the data product
a string specifying a location within the hdf5 file
a string describing the data product component
a list where each element is a vector
containing the labels associated with a particular dimension (e.g.
element 1 corresponds to dimension 1, which corresponds to row names) and
the name of each element describes the contents of each dimension (e.g. age
classes).
(optional) a list of values corresponding to
each dimension (e.g. list element 2 corresponds to columns)
(optional) a list of units corresponding to
each dimension (e.g. list element 2 corresponds to columns)
(optional) a string specifying the units of the data as
a whole
Other write functions:
write_distribution(),
write_estimate(),
write_table()