pax(path, name = getOption("name"), email = getOption("email"), license = getOption("license"), open = is.global(2), news = TRUE, readme = TRUE, rstudio = TRUE, gitignore = TRUE, testthat = TRUE, travis = TRUE, coverage = TRUE, github.user = getOption("github.user"), samples = getOption("samples"), tweak = getOption("tweak"), ...)
c(first="Tyler", last="Rinker"))). This can be set in the
user's options in the ‘.Rprofile’; for example:
options(name = c(first="Tyler", middle = "W.", last="Rinker")).options in the ‘.Rprofile’; for example:
options(email = "tyler.rinker@gmail.com").options in the
‘.Rprofile’; for example:
options(license = "GPL-2").TRUE the project will be opened in RStudio.
The default is to test if new_report is being used in the global
environment, if it is then the project directory will be opened.TRUE a ‘NEWS’ file is generated.TRUE a ‘README.md’ file is generated.TRUE it is assumed
RStudio will be used and a ‘xxx.proj’
file is generated.TRUE a ‘.gitignore’ file is generated.TRUE it is assumed
testthat
will be used and a ‘test’ sub-folder with appropriate testthat
subdirectories and files will be created.TRUE it is assumed
Travis-CI will be used and a ‘travis.yml’
file is generated. For more on managing a ‘travis.yml’ with
R see: https://github.com/craigcitro/r-travis.TRUE it is assumed
covr will be used. This
information will be added to the ‘travis.yml’.options in the ‘.Rprofile’; for
example:
options(github.user = "trinker").TRUE a sample ‘.R’ regular expression
file will be placed in the ‘R’ directory. Additionally, if
testthat = TRUE, a sample ‘.R’ unit test will be placed in the
‘./tests/testthat’ directory.
This can be set in the user's options in the ‘.Rprofile’; for
example:
options(samples = TRUE).qpath (a function that binds
together path pieces; the starting piece is supplied by the path argument,
(3) name (vector of 2: first and last), (4) your email, (5)
path, codeand (6) github.user. This can be argument can be set in
the user's options in the ‘.Rprofile’; for example:
options(tweak = "C:/Users/Tyler/Copy/Public Scripts/augpax.R").
This argument can be a path to or url to a user
specified 'tweaking' function. The user can also pass the function directly
to tweak.tweak
function.pax is a package template system that is NOT designed to be light weight. It is the deluxe, gold version of a package template. **pax** is not flexible, rather it maintains and enforces a narrow package management philosophy.
This function creates a package template. It utilizes a framework with defaults that expects the user to use testthat, Travis-CI and covr (coveralls) to maintain the package. This is not a light weight template, but a deluxe template.
## <strong>Not run</strong>: # pax("DELETE_ME") # # ## Set a package location in .Rprofile and use `ploc` to conveniently # ## complete the full path to where the package should be created # ## # options(dir = file.path(Sys.getenv("USERPROFILE"), "Desktop")) # pax(ploc("DELETE_ME")) # ## <strong>End(Not run)</strong>