Add GeneratorInfo #56

bioDS · Sep 25, 2024 · 3140c59 · 3140c59
1 parent db050b2
commit 3140c59
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/phylonco-lphy/src/main/java/phylonco/lphy/evolution/readcountmodel/CoverageModel.java b/phylonco-lphy/src/main/java/phylonco/lphy/evolution/readcountmodel/CoverageModel.java
@@ -44,7 +44,8 @@ public CoverageModel(
 
     @GeneratorInfo(
             name = "CoverageModel",
-            description = "")
+            narrativeName = "coverage model",
+            description = "A model to simulate the coverage at each site in each cell")
     @Override
     public RandomVariable<Integer[][]> sample(){
         int n = alpha.value().length;

diff --git a/phylonco-lphy/src/main/java/phylonco/lphy/evolution/readcountmodel/PloidyModel.java b/phylonco-lphy/src/main/java/phylonco/lphy/evolution/readcountmodel/PloidyModel.java
@@ -35,6 +35,7 @@ public PloidyModel(
 
     @GeneratorInfo(
             name = "Ploidy",
+            narrativeName = "ploidy model",
             description = "Observed ploidy after allelic dropout.")
 
 

diff --git a/phylonco-lphy/src/main/java/phylonco/lphy/evolution/readcountmodel/ReadCountModel.java b/phylonco-lphy/src/main/java/phylonco/lphy/evolution/readcountmodel/ReadCountModel.java
@@ -6,6 +6,7 @@
 import lphy.core.model.GenerativeDistribution;
 import lphy.core.model.RandomVariable;
 import lphy.core.model.Value;
+import lphy.core.model.annotation.GeneratorInfo;
 import lphy.core.model.annotation.ParameterInfo;
 import phylonco.lphy.evolution.datatype.PhasedGenotype;
 import phylonco.lphy.evolution.datatype.PhasedGenotypeState;
@@ -61,6 +62,10 @@ public ReadCountModel(
         this.w = w;
     }
 
+    @GeneratorInfo(name = "ReadCountModel",
+            narrativeName = "read count model",
+            description = "A model to simulate the read counts at each site in each cell.")
+
     // D ~ GT16 genotypes (Alignment)
     // t ~ ...
     // return ACGT {{1,2,3,4}, {4,5,6,7}, ... }