phlorest

一个cldfbench插件，用于整理语言系统树。

安装

pip install phlorest

用法

启动一个由phlorest整理的数据集

phlorest提供了一个cldfbench数据集模板，用于创建一个由phlorest整理的数据集的文件和目录结构，可以与cldfbench new一起使用。

运行

cldfbench new --template phlorest 

将创建如下所示的数据集骨架

$ tree testtree/
testtree/
├── cldf
│   └── README.md
├── cldfbench_testtree.py
├── etc
│   ├── characters.csv
│   └── taxa.csv
├── metadata.json
├── raw
│   └── README.md
├── setup.cfg
├── setup.py
└── test.py

实现CLDF创建

实现CLDF创建意味着 - 对于任何其他cldfbench整理的数据集 - 在cldfbench_<id>.py中填写Dataset子类的cmd_makecldf方法。

可以在cmd_makecldf中通过args.writer访问的CLDF编写器是phlorest.CLDFWriter的一个实例，它提供了向CLDF数据集添加摘要或后验树的便利方法。至少需要一个摘要来使数据集有效。添加一个如下所示

    args.writer.add_summary(
        self.raw_dir.read_tree(...),
        self.metadata,
        args.log)

运行CLDF创建

实现cmd_makecldf后，可以通过运行来触发CLDF创建

cldfbench makecldf cldfbench_<id>.py

运行来验证生成的CLDF数据集

pytest

发布工作流程

cldfbench makecldf --glottolog-version v4.8 --with-cldfreadme cldfbench_<id>.py
pytest
cldfbench zenodo --communities phlorest cldfbench_<id>.py
cldfbench readme cldfbench_<id>.py
phlorest check --with-R cldfbench_<id>.py
git commit -a -m"release vX.Y"
git push origin
phlorest release cldfbench_<id>.py vX.Y

依赖关系

《Dataset》类的run_treeannotator方法需要安装BEAST中的treeannotator命令。有关如何安装treeannotator（以及BEAST）的详细信息，请参阅https://beast.community/index.html