Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 1.1 KB

DEVELOPMENT.md

File metadata and controls

75 lines (52 loc) · 1.1 KB
Raw

Development Notes

Install from source

  • Install dependencies:
install.packages(c("optparse", "plumber"))
  • Install package from root directory:
install.packages("src/functionsframework/", repo=NULL, type="source")

or

devtools::install()

Install from repo

install.packages("remotes")
remotes::install_github("averikitsch/functions-framework-r")
install.packages("devtools")
devtools::install_github()

When published:

install.packages("functionsframework", dependencies=TRUE)

Create documentation

  1. Install:
install.packages("devtools")
install.packages("roxygen2")
  1. Create framework package (run once):
devtools::create("functionsframework")
  • Update files: DESCRIPTION and NAMESPACE
  • Add dependencies
  1. Add roxygen2 documentation for function, then run:
devtools::document()
  • This creates an .Rd file in the man/ directory
  1. Update rmarkdown in vignettes/functions-framework.Rmd:
devtools::build_vignettes()

Create tar file

devtools::build()