Title: Automated Personal Package Setup
Version: 1.0.3
Description: Functions to setup a personal R package that attaches given libraries and exports personal helper functions.
License: MIT + file LICENSE
URL: https://mrcaseb.github.io/personalr/index.html, https://github.com/mrcaseb/personalr
BugReports: https://github.com/mrcaseb/personalr/issues
Imports: desc, devtools, fs, glue, magrittr, purrr, rprojroot, rstudioapi, usethis, utils, withr, xfun
Suggests: dplyr, tibble
Encoding: UTF-8
RoxygenNote: 7.2.1
NeedsCompilation: no
Packaged: 2022-08-11 21:42:08 UTC; S.Carl
Author: Sebastian Carl [aut, cre]
Maintainer: Sebastian Carl <mrcaseb@gmail.com>
Repository: CRAN
Date/Publication: 2022-08-11 22:00:02 UTC

personalr: Automated Personal Package Setup

Description

logo

Functions to setup a personal R package that attaches given libraries and exports personal helper functions.

Author(s)

Maintainer: Sebastian Carl mrcaseb@gmail.com

See Also

Useful links:

Setup Personal Package

Description

A function to setup a new personal package or update an existing package.

Usage

setup_package(path, packagename, core = NULL)

Arguments

path

The path in which the package shall be created. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.

packagename

The name of the newly generated package. It will be checked to make sure it meets R package naming conventions.

core

A vector or list containing package names that shall be attached when the newly generated package is loaded. The packages must be installed on the current system, otherwise an error will be shown.

Examples


# create package "mypackage" in temporary directory with
# the core packages dplyr, glue and purrr
withr::with_tempdir({
  install.packages(
    c("dplyr", "glue", "purrr"),
    repos = "http://cran.us.r-project.org"
  )
  setup_package(
    path = tempdir(),
    packagename = "mypackage",
    core = c("dplyr", "glue", "purrr")
  )
})

Update Core of Personal Package

Description

Updates the "core" of a personal package created with personalr. It can either append another package to the current core or overwrite it with a new core.

Usage

update_core(path, packagename, core = NULL, append = TRUE)

Arguments

path

The path in which the package shall be created. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.

packagename

The name of the newly generated package. It will be checked to make sure it meets R package naming conventions.

core

A vector or list containing package names that shall be attached when the newly generated package is loaded. The packages must be installed on the current system, otherwise an error will be shown.

append

If TRUE the packages of the argument core will be appended to the current core and the package version will be increased on the "patch" level. Otherwise core will be overwritten and the package version will be increased on the "minor" level.