phenopackets 2.0.2.post4

将 phenopackets 包含到您的项目中

Java 开发者可以通过使用 Maven 导入 jar 将 phenopackets 纳入其代码中

<dependency>
    <groupId>org.phenopackets</groupId>
    <artifactId>phenopacket-schema</artifactId>
    <version>${phenopacket-schema.version}</version>
</dependency>

在 Python 中使用 phenopackets 也同样简单

pip install phenopackets

直接交换 Phenopackets

如何使用这些的示例可以在测试目录中找到。phenopacket 中的字段之间（除了家系之外）没有定义显式关系，因此交换 phenopackets 的资源必须同意哪些是有效的，以及字段与 phenopacket 中其他字段的关系意味着什么。例如，Phenopacket.genes 字段可能被同意代表一个基因面板的基因，或者一组候选基因，或者可能是诊断的致病基因。

JSON/YAML 格式

可以使用来自 protobuf-java-util 库的 JsonFormat 类将 Phenopacket 之间在原生二进制格式和 JSON 之间转换。这也需要添加到您的 pom.xml 中

<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java-util</artifactId>
    <version>${protobuf.version}</version>
</dependency>

pip install protobuf

protobuf-java-util 为 Java 和 protobuf 为 Python 包含执行这些转换的简单实用方法。使用示例在此处展示

// Transform a Phenopacket into JSON
Phenopacket original = TestExamples.rareDiseasePhenopacket();

String asJson = JsonFormat.printer().print(original);
System.out.println(asJson);

// Convert the JSON back to a Phenopacket
Phenopacket.Builder phenoPacketBuilder = Phenopacket.newBuilder();
JsonFormat.parser().merge(jsonString, phenoPacketBuilder);
Phenopacket fromJson = phenoPacketBuilder.build();

// Convert the JSON into YAML (using Jackson)
JsonNode jsonNodeTree = new ObjectMapper().readTree(jsonString);
String yamlPhenopacket = new YAMLMapper().writeValueAsString(jsonNodeTree);

// Convert the YAML back into JSON (using Jackson)
JsonNode jsonNodeTree = new YAMLMapper().readTree(yamlString);
String jsonPhenopacket = new ObjectMapper().writeValueAsString(jsonNodeTree);

// And finally back into a Java object
Phenopacket.Builder phenoPacketBuilder2 = Phenopacket.newBuilder();
JsonFormat.parser().merge(jsonPhenopacket, phenoPacketBuilder2);
Phenopacket fromJson2 = phenoPacketBuilder2.build();

from google.protobuf.json_format import Parse, MessageToJson
from google.protobuf.timestamp_pb2 import Timestamp
from phenopackets import Phenopacket, Individual, PhenotypicFeature, OntologyClass

# Parsing phenopackets from json
with open('file.json', 'r') as jsfile:
    phenopacket = Parse(message=Phenopacket(), text=jsfile.read())

# Writing phenopackets to json
with open('file.json', 'w') as jsfile:
    subject = Individual(id="Zaphod", sex="MALE", date_of_birth=Timestamp(seconds=-123456798))
    phenotypic_features = [PhenotypicFeature(type=OntologyClass(id="HG2G:00001", label="Hoopy")),
                           PhenotypicFeature(type=OntologyClass(id="HG2G:00002", label="Frood"))]

    phenopacket = Phenopacket(id="PPKT:1", subject=subject, phenotypic_features=phenotypic_features)

    json = MessageToJson(phenopacket)
    jsfile.write(json)

从模式构建新消息

在 mme.proto 文件中包含了如何执行此操作的示例。在此处，Matchmaker Exchange (MME) API 已使用 phenopackets 模式实现，根据需要定义了自定义消息，但在适用的情况下重新使用了来自 base.proto 的消息。使用上述示例，也许 Phenopacket.genes 是一个问题，因为您不仅想记录已订购的基因面板，还想在两个单独的字段中记录发现的候选基因。在这种情况下，可以创建一个全新的定制消息，使用 Gene 作为构建块。