hictk/0.0.11

Blazing fast toolkit to work with .hic and .cool files
Recipe info
2024-03-26

Available packages
Header Only

Install
Add the following line to your conanfile.txt:
[requires]
hictk/0.0.11

Using hictk

Note

If you are a new Conan user, we recommend reading the how to consume packages tutorial.

If you need additional assistance, please ask a question in the Conan Center Index repository.

Simplest use case consuming this recipe and assuming CMake as your local build tool:

[requires]
hictk/0.0.11
[generators]
CMakeDeps
CMakeToolchain
[layout]
cmake_layout
from conan import ConanFile
from conan.tools.cmake import cmake_layout


class ExampleRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeDeps", "CMakeToolchain"

    def requirements(self):
        self.requires("hictk/0.0.11")

    def layout(self):
        cmake_layout(self)

Now, you can run this Conan command to locally install (and build if necessary) this recipe and its dependencies (if any):

$ conan install conanfile.txt --build=missing

Useful information to take into account to consume this library:


These are the main declared targets:

  • CMake package name(s): hictk
  • CMake target name(s): hictk::libhictk
  • pkg-config file name(s): hictk.pc

A simple use case using the CMake file name and the global target:

# ...
find_package(hictk REQUIRED)
# ...
target_link_libraries(YOUR_TARGET hictk::libhictk)

These are all the available headers. Some of these ones might be non-public; make sure of it by visiting the hictk homepage listed above:

#include "hictk/balancing/ice.hpp"
#include "hictk/balancing/impl/ice_impl.hpp"
#include "hictk/balancing/impl/scale_impl.hpp"
#include "hictk/balancing/impl/sparse_matrix_impl.hpp"
#include "hictk/balancing/impl/vc_impl.hpp"
#include "hictk/balancing/impl/weights_impl.hpp"
#include "hictk/balancing/methods.hpp"
#include "hictk/balancing/scale.hpp"
#include "hictk/balancing/sparse_matrix.hpp"
#include "hictk/balancing/vc.hpp"
#include "hictk/balancing/weights.hpp"
#include "hictk/bin.hpp"
#include "hictk/bin_table.hpp"
#include "hictk/bin_table_fixed.hpp"
#include "hictk/bin_table_variable.hpp"
#include "hictk/chromosome.hpp"
#include "hictk/common.hpp"
#include "hictk/cooler.hpp"
#include "hictk/cooler/attribute.hpp"
#include "hictk/cooler/common.hpp"
#include "hictk/cooler/cooler.hpp"
#include "hictk/cooler/dataset.hpp"
#include "hictk/cooler/group.hpp"
#include "hictk/cooler/impl/attribute_impl.hpp"
#include "hictk/cooler/impl/dataset_accessors_impl.hpp"
#include "hictk/cooler/impl/dataset_impl.hpp"
#include "hictk/cooler/impl/dataset_iterator_impl.hpp"
#include "hictk/cooler/impl/dataset_read_impl.hpp"
#include "hictk/cooler/impl/dataset_write_impl.hpp"
#include "hictk/cooler/impl/file_accessors_impl.hpp"
#include "hictk/cooler/impl/file_impl.hpp"
#include "hictk/cooler/impl/file_read_impl.hpp"
#include "hictk/cooler/impl/file_standard_attr_impl.hpp"
#include "hictk/cooler/impl/file_validation_impl.hpp"
#include "hictk/cooler/impl/file_write_impl.hpp"
#include "hictk/cooler/impl/index_impl.hpp"
#include "hictk/cooler/impl/multires_cooler_impl.hpp"
#include "hictk/cooler/impl/pixel_selector_impl.hpp"
#include "hictk/cooler/impl/singlecell_cooler_impl.hpp"
#include "hictk/cooler/impl/uri_impl.hpp"
#include "hictk/cooler/impl/utils_copy_impl.hpp"
#include "hictk/cooler/impl/utils_equal_impl.hpp"
#include "hictk/cooler/impl/utils_impl.hpp"
#include "hictk/cooler/impl/utils_merge_impl.hpp"
#include "hictk/cooler/impl/utils_rename_chroms_impl.hpp"
#include "hictk/cooler/impl/validation_impl.hpp"
#include "hictk/cooler/index.hpp"
#include "hictk/cooler/multires_cooler.hpp"
#include "hictk/cooler/pixel_selector.hpp"
#include "hictk/cooler/singlecell_cooler.hpp"
#include "hictk/cooler/uri.hpp"
#include "hictk/cooler/utils.hpp"
#include "hictk/cooler/validation.hpp"
#include "hictk/default_delete.hpp"
#include "hictk/file.hpp"
#include "hictk/fmt.hpp"
#include "hictk/fmt/bin.hpp"
#include "hictk/fmt/chromosome.hpp"
#include "hictk/fmt/common.hpp"
#include "hictk/fmt/genomic_interval.hpp"
#include "hictk/fmt/pixel.hpp"
#include "hictk/generic_variant.hpp"
#include "hictk/genomic_interval.hpp"
#include "hictk/git.hpp"
#include "hictk/hash.hpp"
#include "hictk/hic.hpp"
#include "hictk/hic/block_reader.hpp"
#include "hictk/hic/cache.hpp"
#include "hictk/hic/common.hpp"
#include "hictk/hic/file_reader.hpp"
#include "hictk/hic/file_writer.hpp"
#include "hictk/hic/file_writer_data_structures.hpp"
#include "hictk/hic/file_zoomify.hpp"
#include "hictk/hic/footer.hpp"
#include "hictk/hic/footer_cache.hpp"
#include "hictk/hic/header.hpp"
#include "hictk/hic/impl/block_cache_impl.hpp"
#include "hictk/hic/impl/block_reader_impl.hpp"
#include "hictk/hic/impl/file_reader_impl.hpp"
#include "hictk/hic/impl/file_writer_data_structures_impl.hpp"
#include "hictk/hic/impl/file_writer_impl.hpp"
#include "hictk/hic/impl/file_zoomify_impl.hpp"
#include "hictk/hic/impl/footer_cache_impl.hpp"
#include "hictk/hic/impl/footer_impl.hpp"
#include "hictk/hic/impl/header_impl.hpp"
#include "hictk/hic/impl/hic_file_impl.hpp"
#include "hictk/hic/impl/index_impl.hpp"
#include "hictk/hic/impl/interaction_block_impl.hpp"
#include "hictk/hic/impl/interaction_to_block_mapper_impl.hpp"
#include "hictk/hic/impl/pixel_selector_impl.hpp"
#include "hictk/hic/impl/utils_impl.hpp"
#include "hictk/hic/impl/utils_merge_impl.hpp"
#include "hictk/hic/impl/validation_impl.hpp"
#include "hictk/hic/impl/weight_cache_impl.hpp"
#include "hictk/hic/index.hpp"
#include "hictk/hic/interaction_block.hpp"
#include "hictk/hic/interaction_to_block_mapper.hpp"
#include "hictk/hic/pixel_selector.hpp"
#include "hictk/hic/utils.hpp"
#include "hictk/hic/validation.hpp"
#include "hictk/impl/bin_impl.hpp"
#include "hictk/impl/bin_table_fixed_impl.hpp"
#include "hictk/impl/bin_table_impl.hpp"
#include "hictk/impl/bin_table_variable_impl.hpp"
#include "hictk/impl/chromosome_impl.hpp"
#include "hictk/impl/file_impl.hpp"
#include "hictk/impl/genomic_interval_impl.hpp"
#include "hictk/impl/multires_file_impl.hpp"
#include "hictk/impl/numeric_utils_impl.hpp"
#include "hictk/impl/pixel_impl.hpp"
#include "hictk/impl/reference_impl.hpp"
#include "hictk/impl/variant_buff_impl.hpp"
#include "hictk/multires_file.hpp"
#include "hictk/numeric_utils.hpp"
#include "hictk/numeric_variant.hpp"
#include "hictk/pixel.hpp"
#include "hictk/reference.hpp"
#include "hictk/string_utils.hpp"
#include "hictk/suppress_warnings.hpp"
#include "hictk/tmpdir.hpp"
#include "hictk/transformers.hpp"
#include "hictk/transformers/coarsen.hpp"
#include "hictk/transformers/impl/coarsen_impl.hpp"
#include "hictk/transformers/impl/join_genomic_coords_impl.hpp"
#include "hictk/transformers/impl/pixel_merger_impl.hpp"
#include "hictk/transformers/impl/stats_impl.hpp"
#include "hictk/transformers/join_genomic_coords.hpp"
#include "hictk/transformers/pixel_merger.hpp"
#include "hictk/transformers/stats.hpp"
#include "hictk/type_pretty_printer.hpp"
#include "hictk/type_traits.hpp"
#include "hictk/variant_buff.hpp"
#include "hictk/version.hpp"