@berntpopp/phenopackets-js v1.0.2

Phenopackets-JS

A JavaScript library for working with GA4GH Phenopackets, generated from the official phenopacket-schema protobuf definitions.

Quick Start

npm install @berntpopp/phenopackets-js

const pps = require('@berntpopp/phenopackets-js');

// Create a phenopacket
const phenopacket = new pps.v2.Phenopacket();
phenopacket.setId('example-1');

// Add metadata (required)
const metaData = new pps.v2.core.MetaData();
metaData.setCreated(pps.jsonUtils.dateToTimestamp(new Date()));
metaData.setCreatedBy('example-creator');
phenopacket.setMetaData(metaData);

Documentation

Full documentation, including guides and API reference, is available at: https://berntpopp.github.io/phenopackets-js/

• Installation Guide
• Basic Usage
• API Reference
• Development Guide

License

• Library: MIT License. See the LICENSE file.
• Schema: BSD 3-Clause License by GA4GH. Copyright (c) 2018-2024, Global Alliance for Genomics and Health.