data_frame.hpp File Reference

Validation for data frames. More...

#include "H5Cpp.h"
#include "ritsuko/ritsuko.hpp"
#include "ritsuko/hdf5/hdf5.hpp"
#include "ritsuko/hdf5/vls/vls.hpp"
#include <cstdint>
#include <string>
#include <stdexcept>
#include <vector>
#include <filesystem>
#include <unordered_set>
#include "utils_public.hpp"
#include "utils_string.hpp"
#include "utils_factor.hpp"
#include "utils_other.hpp"
#include "utils_json.hpp"

Include dependency graph for data_frame.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	takane
	takane validation functions.

Functions
void	takane::data_frame::validate (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
size_t	takane::data_frame::height (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
std::vector< size_t >	takane::data_frame::dimensions (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)

Detailed Description

Validation for data frames.

Function Documentation

dimensions()

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

inline

Parameters

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

Returns

A vector of length 2 containing the number of rows and columns in the data frame.

height()

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

inline

Parameters

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

Returns

The number of rows.

validate()

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

inline

Parameters

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