phykit 2.1.81__tar.gz → 2.1.82__tar.gz

{phykit-2.1.81 → phykit-2.1.82}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: phykit
-Version: 2.1.81
+Version: 2.1.82
 Home-page: https://github.com/jlsteenwyk/phykit
 Author: Jacob L. Steenwyk
 Author-email: jlsteenwyk@gmail.com

{phykit-2.1.81 → phykit-2.1.82}/phykit/cli_registry.py

@@ -118,6 +118,9 @@ ALIAS_TO_HANDLER: Dict[str, str] = {
     "casr": "concordance_asr",
     "simmap": "stochastic_character_map",
     "scm": "stochastic_character_map",
+    "simmap_summary": "simmap_summary",
+    "smsummary": "simmap_summary",
+    "describe_simmap": "simmap_summary",
     "contmap": "cont_map",
     "cmap": "cont_map",
     "densitymap": "density_map",

{phykit-2.1.81 → phykit-2.1.82}/phykit/phykit.py

@@ -254,6 +254,8 @@ class Phykit:
                     - fit phylogenetic logistic regression (Ives & Garland 2010)
                 stochastic_character_map (alias: simmap; scm)
                     - stochastic character mapping (SIMMAP) of discrete traits
+                simmap_summary (alias: smsummary; describe_simmap)
+                    - per-branch SIMMAP summary with node posteriors
                 cont_map (alias: contmap; cmap)
                     - continuous trait map (contMap) visualization on a phylogeny
                 trait_rate_map (alias: rate_map; branch_rates)
@@ -4796,6 +4798,79 @@ class Phykit:
         _add_json_argument(parser)
         _run_service(parser, argv, StochasticCharacterMap)
 
+    @staticmethod
+    def simmap_summary(argv):
+        parser = _new_parser(
+            description=textwrap.dedent(
+                f"""\
+                {help_header}
+
+                Run N stochastic character maps and summarize per-branch
+                dwelling time proportions, expected transitions, and
+                posterior state probabilities at each node.
+
+                This extends stochastic_character_map by providing a
+                detailed per-branch summary analogous to
+                phytools::describe.simmap() in R.
+
+                Aliases:
+                  simmap_summary, smsummary, describe_simmap
+                Command line interfaces:
+                  pk_simmap_summary, pk_smsummary, pk_describe_simmap
+
+                Usage:
+                phykit simmap_summary -t <tree> -d <trait_data> -c <trait>
+                  [-m/--model ER|SYM|ARD] [-n/--nsim <int>]
+                  [--seed <int>] [--plot <file>] [--csv <file>] [--json]
+
+                Options
+                =====================================================
+                -t/--tree                   phylogenetic tree file
+                                            (required)
+
+                -d/--trait_data             tab-delimited trait file
+                                            with header row (required)
+
+                -c/--trait                  column name for the
+                                            discrete character trait
+                                            (required)
+
+                -m/--model                  substitution model: ER
+                                            (equal rates), SYM
+                                            (symmetric), or ARD (all
+                                            rates different). Default: ER
+
+                -n/--nsim                   number of stochastic maps
+                                            to simulate (default: 100)
+
+                --seed                      random seed for
+                                            reproducibility
+
+                --plot                      output plot file showing
+                                            tree with posterior pie
+                                            charts at nodes
+
+                --csv                       output CSV file with
+                                            per-branch dwelling
+                                            proportions and node
+                                            posteriors
+
+                --json                      output results as JSON
+                """
+            ),
+        )
+        parser.add_argument("-t", "--tree", type=str, required=True, help=SUPPRESS, metavar="")
+        parser.add_argument("-d", "--trait_data", type=str, required=True, help=SUPPRESS, metavar="")
+        parser.add_argument("-c", "--trait", type=str, required=True, help=SUPPRESS, metavar="")
+        parser.add_argument("-m", "--model", type=str, required=False, default="ER", help=SUPPRESS, metavar="")
+        parser.add_argument("-n", "--nsim", type=int, required=False, default=100, help=SUPPRESS, metavar="")
+        parser.add_argument("--seed", type=int, required=False, default=None, help=SUPPRESS, metavar="")
+        parser.add_argument("--plot", type=str, required=False, default=None, help=SUPPRESS, metavar="")
+        parser.add_argument("--csv", type=str, required=False, default=None, help=SUPPRESS, metavar="")
+        add_plot_arguments(parser)
+        _add_json_argument(parser)
+        _run_service(parser, argv, SimmapSummary)
+
     @staticmethod
     def cont_map(argv):
         parser = _new_parser(
@@ -8897,6 +8972,10 @@ def stochastic_character_map(argv=None):
     Phykit.stochastic_character_map(sys.argv[1:])
 
 
+def simmap_summary(argv=None):
+    Phykit.simmap_summary(sys.argv[1:])
+
+
 def cont_map(argv=None):
     Phykit.cont_map(sys.argv[1:])
 

{phykit-2.1.81 → phykit-2.1.82}/phykit/service_factories.py

@@ -76,6 +76,7 @@ Phylomorphospace = _LazyServiceFactory("phykit.services.tree.phylomorphospace",
 PhylogeneticRegression = _LazyServiceFactory("phykit.services.tree.phylogenetic_regression", "PhylogeneticRegression")
 PhylogeneticGLM = _LazyServiceFactory("phykit.services.tree.phylogenetic_glm", "PhylogeneticGLM")
 PhyloLogistic = _LazyServiceFactory("phykit.services.tree.phylo_logistic", "PhyloLogistic")
+SimmapSummary = _LazyServiceFactory("phykit.services.tree.simmap_summary", "SimmapSummary")
 StochasticCharacterMap = _LazyServiceFactory("phykit.services.tree.stochastic_character_map", "StochasticCharacterMap")
 ContMap = _LazyServiceFactory("phykit.services.tree.cont_map", "ContMap")
 DensityMap = _LazyServiceFactory("phykit.services.tree.density_map", "DensityMap")

{phykit-2.1.81 → phykit-2.1.82}/phykit/services/tree/__init__.py

@@ -40,6 +40,7 @@ _EXPORTS = {
     "RobinsonFouldsDistance": "rf_distance",
     "RootTree": "root_tree",
     "Saturation": "saturation",
+    "SimmapSummary": "simmap_summary",
     "Spr": "spr",
     "SpuriousSequence": "spurious_sequence",
     "TerminalBranchStats": "terminal_branch_stats",