1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
#ifndef TAKANE_SUMMARIZED_EXPERIMENT_HPP
#define TAKANE_SUMMARIZED_EXPERIMENT_HPP
#include "millijson/millijson.hpp"
#include "byteme/byteme.hpp"
#include "utils_public.hpp"
#include "utils_other.hpp"
#include "utils_summarized_experiment.hpp"
#include <filesystem>
#include <stdexcept>
#include <string>
/**
* @file summarized_experiment.hpp
* @brief Validation for summarized experiments.
*/
namespace takane {
/**
* @cond
*/
void validate(const std::filesystem::path&, const ObjectMetadata&, Options& options);
size_t height(const std::filesystem::path&, const ObjectMetadata&, Options& options);
std::vector<size_t> dimensions(const std::filesystem::path&, const ObjectMetadata&, Options& options);
bool satisfies_interface(const std::string&, const std::string&, const Options&);
/**
* @endcond
*/
/**
* @namespace takane::summarized_experiment
* @brief Definitions for summarized experiments.
*/
namespace summarized_experiment {
/**
* @param path Path to the directory containing the summarized experiment.
* @param metadata Metadata for the object, typically read from its `OBJECT` file.
* @param options Validation options.
*/
inline void validate(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
const auto& semap = internal_json::extract_typed_object_from_metadata(metadata.other, "summarized_experiment");
const std::string& vstring = internal_json::extract_string_from_typed_object(semap, "version", "summarized_experiment");
auto version = ritsuko::parse_version_string(vstring.c_str(), vstring.size(), /* skip_patch = */ true);
if (version.major != 1) {
throw std::runtime_error("unsupported version string '" + vstring + "'");
}
// Validating the dimensions.
auto dims = internal_summarized_experiment::extract_dimensions_json(semap, "summarized_experiment");
size_t num_rows = dims.first;
size_t num_cols = dims.second;
// Checking the assays. The directory is also allowed to not exist,
// in which case we have no assays.
auto adir = path / "assays";
if (std::filesystem::exists(adir)) {
size_t num_assays = internal_summarized_experiment::check_names_json(adir);
for (size_t i = 0; i < num_assays; ++i) {
auto aname = std::to_string(i);
auto apath = adir / aname;
auto ameta = read_object_metadata(apath);
::takane::validate(apath, ameta, options);
auto dims = ::takane::dimensions(apath, ameta, options);
if (dims.size() < 2) {
throw std::runtime_error("object in 'assays/" + aname + "' should have two or more dimensions");
}
if (dims[0] != num_rows) {
throw std::runtime_error("object in 'assays/" + aname + "' should have the same number of rows as its parent '" + metadata.type + "'");
}
if (dims[1] != num_cols) {
throw std::runtime_error("object in 'assays/" + aname + "' should have the same number of columns as its parent '" + metadata.type + "'");
}
}
size_t num_dir_obj = internal_other::count_directory_entries(adir);
if (num_dir_obj - 1 != num_assays) { // -1 to account for the names.json file itself.
throw std::runtime_error("more objects than expected inside the 'assays' subdirectory");
}
}
auto rd_path = path / "row_data";
if (std::filesystem::exists(rd_path)) {
auto rdmeta = read_object_metadata(rd_path);
if (!satisfies_interface(rdmeta.type, "DATA_FRAME", options)) {
throw std::runtime_error("object in 'row_data' should satisfy the 'DATA_FRAME' interface");
}
::takane::validate(rd_path, rdmeta, options);
if (::takane::height(rd_path, rdmeta, options) != num_rows) {
throw std::runtime_error("data frame at 'row_data' should have number of rows equal to that of the '" + metadata.type + "'");
}
}
auto cd_path = path / "column_data";
if (std::filesystem::exists(cd_path)) {
auto cdmeta = read_object_metadata(cd_path);
if (!satisfies_interface(cdmeta.type, "DATA_FRAME", options)) {
throw std::runtime_error("object in 'column_data' should satisfy the 'DATA_FRAME' interface");
}
::takane::validate(cd_path, cdmeta, options);
if (::takane::height(cd_path, cdmeta, options) != num_cols) {
throw std::runtime_error("data frame at 'column_data' should have number of rows equal to the number of columns of its parent '" + metadata.type + "'");
}
}
internal_other::validate_metadata(path, "other_data", options);
}
/**
* @param path Path to a directory containing a summarized experiment.
* @param metadata Metadata for the object, typically read from its `OBJECT` file.
* @param options Validation options.
* @return Number of rows in the summarized experiment.
*/
inline size_t height([[maybe_unused]] const std::filesystem::path& path, const ObjectMetadata& metadata, [[maybe_unused]] Options& options) {
// Assume it's all valid, so we go straight for the kill.
const auto& semap = internal_json::extract_object(metadata.other, "summarized_experiment");
auto dims = internal_summarized_experiment::extract_dimensions_json(semap, "summarized_experiment");
return dims.first;
}
/**
* @param path Path to a directory containing a summarized experiment.
* @param metadata Metadata for the object, typically read from its `OBJECT` file.
* @param options Validation options.
* @return A vector of length 2 containing the dimensions of the summarized experiment.
*/
inline std::vector<size_t> dimensions([[maybe_unused]] const std::filesystem::path& path, const ObjectMetadata& metadata, [[maybe_unused]] Options& options) {
// Assume it's all valid, so we go straight for the kill.
const auto& semap = internal_json::extract_object(metadata.other, "summarized_experiment");
auto dims = internal_summarized_experiment::extract_dimensions_json(semap, "summarized_experiment");
return std::vector<size_t>{ dims.first, dims.second };
}
}
}
#endif
|
