README.md

In mattg3004/SchistoxpkgR:

SchistoxpkgR

This R library is a wrapper for the Julia package Schistoxpkg (https://github.com/mattg3004/Schistoxpkg.jl).

Installation

This package uses JuliaCall in R in order to run the Julia package. If you are using Ubuntu or Debian, then it is likely that JuliaCall will not work correctly as described here: https://github.com/Non-Contradiction/JuliaCall/issues/99. There is a workaround for this problem described here: https://github.com/Non-Contradiction/JuliaCall/pull/143.

To install the master branch of the package you need to have devtools installed. If this isn't installed, then install it with:

> install.packages("devtools")

After this, you can run the following to install the package:

> library(devtools) 
> devtools::install_github('mattg3004/SchistoxpkgR', build_vignettes=T)

This will build a vignette, which will take some time, so the installation of the package may take a few minutes.

After installation is complete, to view the vignette run the following:

> browseVignettes("SchistoxpkgR")

mattg3004/SchistoxpkgR documentation built on March 1, 2023, 10:46 a.m.