use D.taxa() and deprecate taxa(D) #110

LinguaPhylo · Nov 22, 2020 · 9dea135 · 9dea135
1 parent 156a277
commit 9dea135
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 10 deletions.
diff --git a/examples/dataModelBlocks.lphy b/examples/dataModelBlocks.lphy
@@ -1,7 +1,7 @@
 data {
   D = readNexus(file="examples/primate.nex");
   L = nchar(D);
-  taxa = D.getTaxa();
+  taxa = D.taxa();
 }
 model {
   theta ~ LogNormal(meanlog=3, sdlog=1);

diff --git a/examples/fullDataExample.lphy b/examples/fullDataExample.lphy
@@ -1,7 +1,7 @@
 data {
   D = readNexus(file="examples/primate.nex");
   L = nchar(D);
-  taxa = D.getTaxa();
+  taxa = D.taxa();
 }
 model {
   theta ~ LogNormal(meanlog=3, sdlog=1);

diff --git a/examples/h3n2.lphy b/examples/h3n2.lphy
@@ -1,7 +1,7 @@
 data {
   options = {ageDirection="forward", ageRegex="_(\d*\.\d+|\d+\.\d*)$"};
   D = readFasta(file="examples/h3n2_2deme.fna", options=options);
-  taxa = D.getTaxa();
+  taxa = D.taxa();
   L = nchar(D);
   demes = split(str=D.getTaxaNames(), regex="_", i=1);
 }

diff --git a/src/lphy/core/functions/TaxaFunction.java b/src/lphy/core/functions/TaxaFunction.java
@@ -9,6 +9,7 @@
 
 import java.util.Arrays;
 
+@Deprecated
 public class TaxaFunction extends DeterministicFunction<Taxa> {
 
     final String paramName;
@@ -18,6 +19,7 @@ public TaxaFunction(@ParameterInfo(name = "taxa", description = "the taxa value
         setParam(paramName, x);
     }
 
+    @Deprecated
     @GeneratorInfo(name="taxa",description = "The taxa of the given taxa-dimensioned object (e.g. alignment, tree et cetera).")
     public Value<Taxa> apply() {
         Value v = getParams().get(paramName);

diff --git a/src/lphy/evolution/alignment/AbstractAlignment.java b/src/lphy/evolution/alignment/AbstractAlignment.java
@@ -82,12 +82,24 @@ public AbstractAlignment(final AbstractAlignment source) {
     public abstract boolean hasParts();
 
 
-    //****** Sites ******
+    //****** MethodInfo ******
+
     @MethodInfo(description="The number of characters/sites in this alignment.")
     public Integer nchar() {
         return nchar;
     }
 
+    @Override
+    @MethodInfo(description="The names of the taxa.")
+    public String[] getTaxaNames() {
+        return taxa.getTaxaNames();
+    }
+
+    @MethodInfo(description = "the taxa of the alignment.")
+    public Taxa taxa() {
+        return getTaxa();
+    }
+
     //****** Taxa ******
 
     @Override
@@ -109,18 +121,12 @@ public String getTaxonName(int taxonIndex) {
         return getTaxon(taxonIndex).getName();
     }
 
-    @Override
-    @MethodInfo(description="The names of the taxa.")
-    public String[] getTaxaNames() {
-        return taxa.getTaxaNames();
-    }
 
     @Override
     public Taxon[] getTaxonArray() {
         return taxa.getTaxonArray();
     }
 
-    @MethodInfo(description = "the taxa of the alignment.")
     public Taxa getTaxa() {
         return taxa;
     }