Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.15 KB

README.md

File metadata and controls

38 lines (28 loc) · 1.15 KB

flowkernel project

This repository contains the flowkernel R package, which can be installed as follows:

remotes::install_github("jacobbien/flowkernel-project", subdir = "flowkernel")

It is implemented using literate programming with litr. Thus, the source code is in the form of a bookdown, available here.

To modify the code in this R package, modify the .Rmd files in the create-flowkernel/ directory and then (from an R session in this directory) run the following:

litr::render("create-flowkernel/index.Rmd")
fs::dir_copy("create-flowkernel/_book", "docs/create", overwrite = TRUE)
fs::dir_delete("create-flowkernel/_book")
fs::dir_copy("create-flowkernel/flowkernel", "flowkernel", overwrite = TRUE)
fs::dir_delete("create-flowkernel/flowkernel")
fs::dir_delete("create-flowkernel/_main_files/")

To install the latest version of litr, run

remotes::install_github("jacobbien/litr-project", subdir = "litr")