write_table: Write table component to HDF5 file

Description Usage Arguments Value See Also

View source: R/write_table.R

Description

Function to populate hdf5 file with array type data.

Usage

1
2
3
4
5
6
7
8
9
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()


rDataPipeline documentation built on Nov. 18, 2021, 1:14 a.m.