This function will run all checks within the package. See the corresponding check functions for details. When default = "true", all checks will run unless the associated environment variable is "false".

check_via_env(
  pkg = NULL,
  lintr = NULL,
  namespace = NULL,
  r_filenames = NULL,
  version = NULL,
  gitignore = NULL,
  tidy_description = NULL,
  readme = NULL,
  file_permissions = NULL,
  line_breaks = NULL,
  tag = NULL,
  news = NULL,
  rproj = NULL,
  default = FALSE
)

Arguments

pkg

Build and check package. See details for further information.

lintr, namespace, r_filenames, version, gitignore, readme, tidy_description

Default NULL.

file_permissions, line_breaks

Windows related checks.

tag

Default NULL. Create a tagged release.

news

Check the top line of NEWS.md

rproj

Check Rproject file

default

Default FALSE. The default value the environment variable should take if missing.

Details

The arguments for the function correspond to a particular check, e.g. check_ARGNAME(). By default, all arguments are NULL and hence run. However, a value of FALSE or changing the corresponding environment variable INTERGRATE_ARGNAME can turn off the check, e.g.INTERGRATE_NAMESPACE.

On GitLab you can set environment variables at an organisation level.

Note: As this package matures, this function will include the newer checks.