Package 'gDRstyle'

Avoid new lines in sprintf output. Function helps to avoid line lenght limits without affecting sprintf output

Description

Avoid new lines in sprintf output. Function helps to avoid line lenght limits without affecting sprintf output

Usage

avoid_new_lines(fmt)

Arguments

fmt	string, formatted as sprintf input

Value

string

Examples

sprintf(avoid_new_lines(
  "Lorem ipsum dolor sit amet, %s adipiscing elit, sed do eiusmod
  tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
  veniam."
), "consectetur")

---

Check for alignment of package dependencies across Rplatform and package specifications.

Description

Check the package depedency version specifications in the rplatform/dependencies.yaml and DESCRIPTION.

Usage

checkDependencies(
  dep_path,
  desc_path,
  skip_pkgs = "R",
  combo_path = "/mnt/vol/dependencies_combo.yaml"
)

Arguments

dep_path	String of path to the rplatform dependencies.yaml file.
desc_path	String of the path to the package DESCRIPTION file.
skip_pkgs	vector of packages from DESCRIPTION to skip; defaults to R
combo_path	String of path to the combo image dependencies.yaml file. Defaults to the current directory.

Details

This function is used for its side effects in the event that there are dependency clashes.

Value

NULL invisibly.

Examples

checkDependencies(
  dep_path = 
        system.file(package = "gDRstyle", "testdata", "dependencies.yaml"),
  desc_path = system.file(package = "gDRstyle", "DESCRIPTION"),
  skip_pkgs = c("testthat", "lintr")
)

---

Check R package

Description

Used in gDR platform pacakges' CI/CD pipelines to check that the package abides by gDRstyle stylistic requirements, passes rcmdcheck, and ensures that the dependencies.yml file used to build gDR platform's docker image is kept up-to-date with the dependencies listed in the package's DESCRIPTION file.

Usage

checkPackage(
  pkgName,
  repoDir,
  subdir = NULL,
  fail_on = "warning",
  bioc_check = FALSE,
  run_examples = TRUE,
  skip_lint = FALSE,
  skip_tests = FALSE,
  build_vignettes = TRUE,
  check_vignettes = TRUE,
  as_cran = FALSE
)

Arguments

pkgName	String of package name.
repoDir	String of path to repository directory.
subdir	String of relative path to the R package root directory from the repoDir.
fail_on	String specifying the level at which check fail. Supported values: "note", "warning" (default) and "error".
bioc_check	Logical whether bioc check should be performed
run_examples	Logical whether examples check should be performed
skip_lint	skip lint checks
skip_tests	skip tests
build_vignettes	build vignettes
check_vignettes	check vignettes
as_cran	run with as_cran flag

Value

NULL invisibly.

Examples

checkPackage(
  pkgName = "fakePkg",
  repoDir = system.file(package = "gDRstyle", "tst_pkgs", "dummy_pkg"),
  fail_on = "error"
)

---

Install all package dependencies from yaml file for building image purposes

Description

Install all package dependencies from yaml file for building image purposes

Usage

installAllDeps(
  additionalRepos = NULL,
  base_dir = "/mnt/vol",
  use_ssh = FALSE,
  test_mode = FALSE
)

Arguments

additionalRepos	List of additional Repos
base_dir	String of base working directory.
use_ssh	logical, if use ssh keys
test_mode	logical, whether to run the function in the test mode (if TRUE the dependencies are not installed but only listed)

Value

NULL

Examples

installAllDeps(
  base_dir = system.file(package = "gDRstyle", "testdata"),
  test_mode = TRUE
)

---

Install locally cloned repo for builiding image purposes

Description

Install locally cloned repo for builiding image purposes

Usage

installLocalPackage(repo_path, additionalRepos = NULL, base_dir = "/mnt/vol")

Arguments

repo_path	String of repository directory.
additionalRepos	List of additional Repos
base_dir	String of base working directory.

Value

NULL

Examples

installLocalPackage(system.file(
package = "gDRstyle", "tst_pkgs", "dummy_pkg"
))

---

Lint select subdirectories in a package directory.

Description

Lint select subdirectories in a package directory.

Usage

lintPkgDirs(pkg_dir = ".", shiny = FALSE)

Arguments

pkg_dir	String of path to package directory.
shiny	Boolean of whether or not a shiny directory should also be lint. Defaults to the current directory.

Details

Will look for files in the following directories: "R", "tests", and conditionally "inst/shiny" if shiny is TRUE.

Value

NULL invisibly.

Examples

lintPkgDirs(
    pkg_dir= system.file(package = "gDRstyle", "tst_pkgs", "dummy_pkg"))

---

roxygen_tag_linter

Description

Check that function has documented specific tag in Roxygen skeleton (default @author).

Usage

roxygen_tag_linter(tag = "@author")

Arguments

tag	character (default @author)

Value

linter class function

Author(s)

Kamil Foltynski [email protected]

Examples

linters_config <- lintr::linters_with_defaults(
  line_length_linter = lintr::line_length_linter(120),
  roxygen_tag_linter = roxygen_tag_linter()
)

---