hvantk:conventions

Define development standards and architectural patterns for hvantk multiomics plugins.

Updated Feb 2, 2024

Search Tags:#standardization #plugin #bioinformatics #multiomics #hvantk #hail

Ready to run

npx skills add https://github.com/bigbio/hvantk --skill hvantk-conventions

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: hvantk:conventions
Source: https://github.com/bigbio/hvantk/tree/main/hvantk/skills/_conventions
Command: npx skills add https://github.com/bigbio/hvantk --skill hvantk-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides the mandatory architectural contract and development standards for building and maintaining plugins within the hvantk multiomics toolkit, ensuring consistency across diverse data sources.

Core Features & Use Cases

Plugin Standardization: Defines the required structure for plugin manifests, builder functions, and CLI integration.
Lifecycle Management: Outlines the standardized stages for downloading, parsing, and building multiomics datasets.
Use Case: A developer creating a new variant annotation plugin uses these conventions to ensure their builder, drift probe, and test suite integrate seamlessly with the hvantk registry and automated drift detection workflows.

Quick Start

Consult the hvantk conventions skill to verify the required directory structure and manifest schema for a new plugin implementation.

Frequently Asked Questions about hvantk:conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What are the mandatory directory structure requirements for hvantk plugin development?▼

The hvantk conventions mandate a specific directory structure and manifest schema for plugin development. This standardization ensures builder functions, drift probes, and test suites integrate seamlessly with the hvantk registry and automated maintenance workflows.

How do I standardize multiomics data integration plugins for consistent lifecycle management?▼

To standardize multiomics data integration, implement the hvantk conventions governing plugin manifests and builder functions. These conventions outline standardized stages for downloading, parsing, and building datasets to ensure consistent integration.

Does my variant annotation plugin need a drift probe to be compatible with the hvantk registry?▼

Yes, your variant annotation plugin requires a drift probe and test suite to ensure compatibility. The hvantk conventions define these as mandatory components for seamless integration with automated drift detection workflows.

What is the standardized lifecycle for parsing and building multiomics datasets in hvantk?▼

The standardized lifecycle for multiomics datasets in hvantk outlines sequential stages for downloading, parsing, and building. Adhering to these conventions ensures your data source integrates consistently with the toolkit's automated maintenance.

Do I need to follow specific API versioning to maintain hvantk plugin compatibility?▼

Yes, you must adhere to specified API versioning to maintain compatibility. The hvantk conventions require strict compliance with versioning standards to ensure your plugin functions correctly within the hvantk registry.

Why does my hvantk plugin fail automated maintenance workflows?▼

Your hvantk plugin likely fails automated maintenance workflows due to non-compliance with mandatory architectural contracts. The conventions require specific builder functions, drift probes, and test suites to ensure seamless registry integration.