this subdirectory provides an R wrapper for the found python package
disclaimer
very unfinished, more testing is needed before general use can be advised, API is subject to breaking changes under 0ver
installation
after installing the python library (see https://goeva-lab.ccbr.utoronto.ca/found/py for relevant documentation), the R wrapper can be installed via the following command using the pak library:
pak::pak("github::goeva-lab/found/R")documentation
a build of the documentation is publicly available at: https://goeva-lab.ccbr.utoronto.ca/found/R.
to build it locally (and run associated notebooks), a copy of the repo must be downloaded and dev dependencies must be installed:
git clone 'git@github.com:goeva-lab/found' && cd found/R
R -q -e 'pak::local_install_dev_deps(); devtools::document(); pak::local_install()'the manual can then be built using the following command (again using devtools)
a documentation site can be built (using pkgdown) and previewed locally at localhost:8000 via the following command:
note: this will run and execute all guide vignettes, which can be very computationally expensive. to avoid doing this, you can set the env var CI to FALSE prior to invoking R and pass examples = FALSE to the above pkgdown::build_site call as an additional argument.
development/contributing
this project uses air for formatting and lintr for linting.
please ensure that any contributions pass formatting/linting checks accordingly, as determined by air format . --check and lintr::lint_package. contributions should also pass R CMD check.