Installation

To install the fastdfe package in R, execute the following command:

devtools::install_github("Sendrowski/fastDFE")

Once the installation is successfully completed, initiate the package within your R session using:

library(fastdfe)

The fastdfe R package serves as a wrapper around the Python library but re-implements visualization through ggplot2. Because of this, the Python package must be installed separately. This can be accomplished with:

install_fastdfe()

fastdfe is compatible with Python 3.11 through 3.13.

Note

The input backends are optional extras: vcf for VCF files, zarr for VCF-Zarr stores and arg for tree sequences. To enable them, run the following command in R before calling install_fastdfe():

reticulate::py_install("fastdfe[vcf,zarr,arg]", pip = TRUE)

Alternatively, you can also follow the instructions in the Python installation guide to install the Python package.

After installing the Python package, the fastdfe wrapper module can be loaded into your R environment using the following command:

fastdfe <- load_fastdfe()

See the R package documentation for more information on the available functions.