Skip to content

camlhmp

🐪 camlhmp 🐪 - Classification through yAML Heuristic Mapping Protocol

camlhmp is a tool for generating organism typing tools from YAML schemas. Through discussions with Tim Read, we identified a need for a straightforward method to define and manage typing schemas for organisms of interest. YAML was chosen for its simplicity and readability.

Purpose

The primary purpose of camlhmp is to provide a framework that enables researchers to independently define typing schemas for their organisms of interest using YAML. This approach facilitates the management and analysis biological data for researchers at any level of experience.

camlhmp does not supply pre-defined typing schemas. Instead, it equips researchers with the necessary tools to create and maintain their own schemas, ensuring these schemas can easily remain up to date with the latest scientific developments.

Finally, the development of camlhmp was driven by a practical need to streamline maintenance of multiple organism typing tools. Managing these tools separately is time-consuming and challenging. camlhmp simplifies this by providing a single framework for each tool.

Documentation Overview

Installation
Information for installing camlhmp on your system

Available Tools
A list of available typing tools utilizing camlhmp

Schema Definition
Details about defining schemas for use with camlhmp

CLI Reference
Details about available CLI commands from camlhmp

API Reference
Details about using the camlhmp package in your own code

About
Information about the development and funding of camlhmp

Funding

Support for this project came (in part) from the Wyoming Public Health Division, and the Center for Applied Pathogen Epidemiology and Outbreak Control (CAPE).

Wyoming Public Health Division Center for Applied Pathogen Epidemiology and Outbreak Control

Citing camlhmp

If you make use of camlhmp in your analysis, please cite the following: