takane::data_frame_factor Namespace Reference

Definitions for data frame factors. More...

Functions
void	validate (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
size_t	height (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)

Detailed Description

Definitions for data frame factors.

Function Documentation

height()

size_t takane::data_frame_factor::height ( const std::filesystem::path & path, const ObjectMetadata & metadata, Options & options )

inline

Parameters

path	Path to the directory containing the data frame factor.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.

Returns

Length of the factor.

validate()

void takane::data_frame_factor::validate ( const std::filesystem::path & path, const ObjectMetadata & metadata, Options & options )

inline

If Options::data_frame_factor_any_duplicated provided, it enables stricter checking of the uniqueness of the data frame levels. Currently, we don't provide a default method for data_frame objects, as it's kind of tedious and we haven't gotten around to it yet.

Parameters

path	Path to the directory containing the data frame factor.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.