Package 'audit.workbench'

Title: RStudio/Workbench User Acceptance Tests
Description: Testing whether data scientists can do what they expect in Posit Workbench.
Authors: Jumping Rivers [aut, cre]
Maintainer: Jumping Rivers <[email protected]>
License: file LICENSE
Version: 0.6.5
Built: 2025-02-22 19:18:19 UTC
Source: https://github.com/jumpingrivers/audit.workbench

Help Index


Run UAT Checks

Description

This functions runs all UAT tests. To skip tests, set check to 'no' in the config yaml file. See 'create_config()'

Usage

check(server, dir = ".", debug_level = 0:2)

Arguments

server

Posit Workbench server. If NULL, use the ENV variable WORKBENCH_SERVER

dir

directory location of the the config file

debug_level

Integer, 0 to 2.

Details

Debug level description * 0: clean-up all files; suppress all noise * 1: clean-up all files, but display build steps * 2: No clean-up and display build steps


R6 classes

Description

R6 classes

R6 classes

Details

Check classes

Super classes

audit.base::logger -> audit.base::base_check -> check_bioconductor

Methods

Public methods

Inherited methods

Method check()

Checks that Bioconductor URLs are accessible

Usage
check_bioconductor$check(debug_level)
Arguments
debug_level

See check() for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_bioconductor$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 classes

Description

R6 classes

R6 classes

Details

Checks that core R packages are pre-installed as described in https://docs.posit.co/ide/server-pro/reference/r_package_dependencies.html

Super classes

audit.base::logger -> audit.base::base_check -> check_core_r_pkgs

Methods

Public methods

Inherited methods

Method check()

Test for core R packages

Usage
check_core_r_pkgs$check(debug_level)
Arguments
debug_level

See check() for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_core_r_pkgs$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 classes

Description

R6 classes

R6 classes

Details

Check classes

Super classes

audit.base::logger -> audit.base::base_check -> check_cran

Methods

Public methods

Inherited methods

Method check()

Installs a package from CRAN

Usage
check_cran$check(debug_level)
Arguments
debug_level

See check() for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_cran$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 classes

Description

R6 classes

R6 classes

Details

Check classes

Super classes

audit.base::logger -> audit.base::base_check -> check_file_permissions

Methods

Public methods

Inherited methods

Method check()

Check

Usage
check_file_permissions$check(debug_level)
Arguments
debug_level

See check() for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_file_permissions$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 classes

Description

R6 classes

R6 classes

Details

Check classes

Super classes

audit.base::logger -> audit.base::base_check -> check_git_cloning

Methods

Public methods

Inherited methods

Method check()

Checking that we can access and clone from github.com

Usage
check_git_cloning$check(debug_level)
Arguments
debug_level

See 'check()' for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_git_cloning$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 classes

Description

R6 classes

R6 classes

Details

Check classes

Super classes

audit.base::logger -> audit.base::base_check -> check_github

Methods

Public methods

Inherited methods

Method check()

Checks installs a package from github#

Usage
check_github$check(debug_level)
Arguments
debug_level

See check() for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_github$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 classes

Description

R6 classes

R6 classes

Details

Check classes

Super classes

audit.base::logger -> audit.base::base_check -> check_python

Methods

Public methods

Inherited methods

Method check()

Checks python pip install

Usage
check_python_pip$check(debug_level)
Arguments
debug_level

See check() for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_python_pip$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 classes

Description

R6 classes

R6 classes

Details

Check classes

Super classes

audit.base::logger -> audit.base::base_check -> check_python

Methods

Public methods

Inherited methods

Method check()

Checks python can be used via reticulate

Usage
check_python_reticulate$check(debug_level)
Arguments
debug_level

See check() for details


Method clone()

The objects of this class are cloneable with this method.

Usage
check_python_reticulate$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


R6 Quarto checks

Description

A short description...

Usage

types

Format

An object of class character of length 3.


Create test config

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(dir = ".", default = TRUE, type = c("merge", "force", "error"))

Arguments

dir

Directory of the config file

default

Default value for if a test should run (logical)

type

Merge type, see details

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