takane
Validators for ArtifactDB file formats
Loading...
Searching...
No Matches
ranged_summarized_experiment.hpp
Go to the documentation of this file.
1#ifndef TAKANE_RANGED_SUMMARIZED_EXPERIMENT_HPP
2#define TAKANE_RANGED_SUMMARIZED_EXPERIMENT_HPP
3
4#include "millijson/millijson.hpp"
5#include "byteme/byteme.hpp"
6
8
9#include <filesystem>
10#include <stdexcept>
11#include <string>
12
18namespace takane {
19
23void validate(const std::filesystem::path&, const ObjectMetadata&, Options& options);
24size_t height(const std::filesystem::path&, const ObjectMetadata&, Options& options);
25bool derived_from(const std::string&, const std::string&, const Options&);
34namespace ranged_summarized_experiment {
35
41inline void validate(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
42 ::takane::summarized_experiment::validate(path, metadata, options);
43
44 const auto& rsemap = internal_json::extract_typed_object_from_metadata(metadata.other, "ranged_summarized_experiment");
45
46 const std::string& vstring = internal_json::extract_string_from_typed_object(rsemap, "version", "ranged_summarized_experiment");
47 auto version = ritsuko::parse_version_string(vstring.c_str(), vstring.size(), /* skip_patch = */ true);
48 if (version.major != 1) {
49 throw std::runtime_error("unsupported version string '" + vstring + "'");
50 }
51
52 auto rangedir = path / "row_ranges";
53 if (std::filesystem::exists(rangedir)) {
54 auto rangemeta = read_object_metadata(rangedir);
55 if (!derived_from(rangemeta.type, "genomic_ranges", options) && !derived_from(rangemeta.type, "genomic_ranges_list", options)) {
56 throw std::runtime_error("object in 'row_ranges' must be a 'genomic_ranges' or 'genomic_ranges_list'");
57 }
58
59 ::takane::validate(rangedir, rangemeta, options);
60
61 auto num_row = ::takane::summarized_experiment::height(path, metadata, options);
62 if (::takane::height(rangedir, rangemeta, options) != num_row) {
63 throw std::runtime_error("object in 'row_ranges' must have length equal to the number of rows of its parent '" + metadata.type + "'");
64 }
65 }
66}
67
68}
69
70}
71
72#endif
void validate(const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
Definition ranged_summarized_experiment.hpp:41
void validate(const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
Definition summarized_experiment.hpp:44
size_t height(const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
Definition summarized_experiment.hpp:120
takane validation functions.
Definition _derived_from.hpp:15
size_t height(const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
Definition _height.hpp:88
ObjectMetadata read_object_metadata(const std::filesystem::path &path)
Definition utils_public.hpp:74
void validate(const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
Definition _validate.hpp:107
bool derived_from(const std::string &type, const std::string &base, const Options &options)
Definition _derived_from.hpp:80
Object metadata, including the type and other fields.
Definition utils_public.hpp:26
std::unordered_map< std::string, std::shared_ptr< millijson::Base > > other
Definition utils_public.hpp:35
std::string type
Definition utils_public.hpp:30
Validation options.
Definition utils_public.hpp:94
Validation for summarized experiments.