takane::summarized_experiment Namespace Reference

Definitions for summarized experiments. 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)
std::vector< size_t >	dimensions (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)

Detailed Description

Definitions for summarized experiments.

Function Documentation

dimensions()

std::vector< size_t > takane::summarized_experiment::dimensions ( const std::filesystem::path & path, const ObjectMetadata & metadata, Options & options )

inline

Parameters

path	Path to a directory containing a summarized experiment.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.

Returns

A vector of length 2 containing the dimensions of the summarized experiment.

height()

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

inline

Parameters

path	Path to a directory containing a summarized experiment.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.

Returns

Number of rows in the summarized experiment.

validate()

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

inline

Parameters

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