Package 'audit.base'

Description

Used for side effect, i.e. printing to console

Usage

audit_posit_version(posit_version, type = c("connect", "workbench", "drivers"))

Arguments

Examples

audit_posit_version("2023.03.0", type = "connect")

Description

Augments installed software columns

Usage

augment_installed(installed, verbose = TRUE)

print_colour_versions(installed)

Arguments

Description

Base Check Class

Base Check Class

Details

Inherited underlying base class. Shouldn't be used directly

Super class

audit.base::logger -> base_check

Public fields

Methods

Public methods

• base_check$new()

• base_check$info()

• base_check$clone()

Method new()

Set parameters for config file location

Usage

base_check$new(dir = ".", file = "config-uat.yml", debug_level = 0)

Arguments

Method info()

Summarise key class attributes

Usage

base_check$info()

Method clone()

The objects of this class are cloneable with this method.

Usage

base_check$clone(deep = FALSE)

Arguments

Description

In addition to the checks made by serverHeaders we also check that Posit isn't in one of the headers.

Usage

check_server_headers(server)

Arguments

Description

Many R packages require additional system dependencies. This check, obtains a list of system libraries installed on the connect server, then determines which R packages can't be installed.

Usage

check_sys_deps(os_release, installed_libs, debug_level = 0:2)

Arguments

Details

Suppress parameter will be changed in a near-future MR to verbose levels

Description

This function creates an example config. By default all tests are TRUE. Some RSC servers intentionally won't have some features implemented.

Usage

create_config(file, pkg_name)

Arguments

Details

If a test is missing from the config file, it is assume to be TRUE. Therefore, the config file can be quite short and just list exceptions. If the config file is missing, then all tests are carried out.

When merging configs, we either * merge the new with existing * force: overwrite existing file * error: if a config file exists, raise an error

Description

Run on Posit workbench. Determines the system libs that are installed on a machine.

Usage

get_installed_libs()

clean_libs(os_release, libs)

Arguments

Description

Returns a tibble containing the Posit version, date of release, and any associated CVEs

Usage

get_posit_versions(type = c("connect", "workbench", "drivers"), remote = TRUE)

Arguments

Examples

get_posit_versions(type = "connect")

Description

In general not used by users.

Usage

get_quarto_server_header(out)

get_quarto_sys_deps(out)

get_quarto_software_versions(out)

get_quarto_deploy(out)

get_quarto_posit_version_msg(out, type = c("connect", "workbench", "drivers"))

Arguments

Description

Debugging helper functions

Usage

get_suppress(debug_level)

get_debug_level(debug_level)

Arguments

Description

These functions are used by the health check function to initialise and check

Usage

init_r6_checks(dir, file, pkg_name)

init_r6_check(export, dir, file, pkg_name)

Arguments

Description

R6 logger class

R6 logger class

Details

Not called directly, but is inherited by base_check.

Methods

Public methods

• logger$start_logger()

• logger$stop_logger()

• logger$get_log()

• logger$clone()

Method start_logger()

Starts the logger

Usage

logger$start_logger()

Method stop_logger()

Stores the results of the check

Usage

logger$stop_logger(passed)

Arguments

Method get_log()

Retrieve the log

Usage

logger$get_log()

Returns

Check log

Method clone()

The objects of this class are cloneable with this method.

Usage

logger$clone(deep = FALSE)

Arguments

Description

Currently this function would only be called by the package author, as it updates inst/extdata/versions/*.csv

Usage

update_all_versions()