BUILD.md

In sshunsuke/MukherjeeBrill: Mukherjee & Brill model for gas-liquid two-phase flow in a circular pipe

Notes on Build

Environment

• R
• RStudio
• R Packages
• devtools
• roxygen2
• testthat
• (vignette)

Package structure

• DESCRIPTION
• NAMESPACE
• automatically generated by 'devtools'
• LICENSE
• R/*.R
• source code
• man/*.Rd
• automatically generated by 'devtools'
• test/
• test code
• (vignette)

Build

devtools::document()    # Generate documents ('NAMESPACE' and 'man/*.md') from comments in 'R/*.R' with Roxygen
devtools::check()       # Tests run in this process
devtools::build()

devtools::build() generates a tar.gz file, which includes all the files required for the package. You can install the package with the file with the command below.

install.packages("package_0.X.X.tar.gz", repos = NULL, type = "source")

Test

# Initialization
usethis::use_testthat()

# Add a new test file
usethis::use_test("filename")

Vignette

Vignette has not been used in the build process, yet.

# Initialization
usethis::use_vignette("my-vignette")

devtools::build_vignettes()
devtools::clean_vignettes()

sshunsuke/MukherjeeBrill documentation built on Jan. 21, 2022, 6:13 p.m.