Skip to contents

R-CMD-check codecov CRAN Status Badge

This is an R interface to tumopp, a tumor growth simulator in C++.

Requirements

  • Unix-like OS (macOS, Linux, etc.)
  • C++17 compiler (clang++ >= Apple clang 11.0, g++ >= 9.1)
  • CMake

Installation

install.packages("pak")
pak::pak("heavywatal/rtumopp")

The code above tries to find and use an pre-installed tumopp executable in your system. If it is too old or not found, a compatible version will be installed automatically. Manual installation by brew install heavywatal/tap/tumopp is therefore unnecessary, but may be useful to reduce the cost of repetitive installation of the R package.

To ignore pre-installed binary and build a bleeding edge (HEAD) or some specific revision from source, set the environment variable TUMOPP_GIT_TAG before installation:

Sys.setenv(TUMOPP_GIT_TAG = "HEAD")

The installation of tumopp can be checked with the following commands:

tumopp::tumopp_path()
tumopp::tumopp_version()
sessioninfo::session_info("tumopp")

Please include these information when you report issues.

R packages are updated at random times. Please try to check updates once in a while and use the latest versions.

update.packages()
pak::pak("heavywatal/rigraphlite")
pak::pak("heavywatal/rtumopp")

Basic usage

See “Get started” page.

Available parameters are listed in the API document of C++ tumopp.