write_table: Write table component to HDF5 file

In ScottishCovidResponse/hdf5processing: Functions to Interact with the 'FAIR Data Pipeline'

Write table component to HDF5 file

Description

Function to populate hdf5 file with array type data.

Usage

write_table(
  df,
  handle,
  data_product,
  component,
  description,
  row_names,
  column_units
)

Arguments

df	an dataframe containing the data
handle	an object of class fdp, R6 containing metadata required by the Data Pipeline API
data_product	a string specifying the name of the data product
component	a string specifying a location within the hdf5 file,
description	a string describing the data product component
row_names	(optional) a vector of rownames
column_units	(optional) a vector comprising column units

Value

Returns a handle index associated with the just written component, which can be used to raise an issue if necessary

See Also

Other write functions: write_array(), write_distribution(), write_estimate()

ScottishCovidResponse/hdf5processing documentation built on July 19, 2023, 10:46 a.m.