In nickbrazeau/polySimIBD: Structured Wright Fisher Simulator for Malaria Genetics

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

Installing and Loading polySimIBD

To install this package, you will need to first install the remotes package and then run the following command:

remotes::install_github("nickbrazeau/polySimIBD")

Dependencies

polySimIBD relies on the Rcpp package, which requires certain OS-specific dependencies:

• Windows
  • Download and install the appropriate version of Rtools for your version of R. On installation, ensure you check the box to arrange your system PATH as recommended by Rtools
• Mac OS X
  • Download and install XCode
  • Within XCode go to Preferences : Downloads and install the Command Line Tools
• Linux (Debian/Ubuntu)
  • Install the core software development utilities required for R package development as well as LaTeX by executing sudo apt-get install r-base-dev texlive-full

If you have any problems installing then please raise an issue on Github.

Assuming everything installed correctly, you can now load the package:

library(polySimIBD)

Separately, after installing, if you identify any bugs, please raise an issue on Github so they can be addressed.

nickbrazeau/polySimIBD documentation built on Sept. 26, 2024, 5:29 p.m.