cancerscreening-configuration {cancerscreening}

cancerscreening configuration

Description

Some aspects of cancerscreening behaviour can be controlled via an option.

Usage

with_cancerscreening_quiet(code)

local_cancerscreening_quiet(env = parent.frame())

Arguments

code

Code to execute quietly

env

The environment to use for scoping

Value

No return value, called for side effects

No return value, called for side effects

No return value, called for side effects

Messages

The cancerscreening_quiet option can be used to suppress messages form cancerscreening. By default, cancerscreening always messages, i.e. it is not quiet.

set cancerscreening_quiet to TRUE to suppress message, by one of these means, in order of decreasing scope:

• Put options(cancerscreening_quiet = TRUE) in the start-up file, such as .Rprofile, or in your R script

• Use local_cancerscreening_quiet() to silence cancerscreening in a specific scope

• Use with_cancerscreening_quite to run small bit of code silently

local_cancerscreening_quiet and with_cancerscreening follow the conventions of the withr package (https://withr.r-lib.org).

Examples

## Not run: 
  # message: "The credentials have been set."
  khis_cred(username = 'username', password = 'password')

  # suppress messages for a small amount of code
  with_cancerscreening_quiet(
    khis_cred(username = 'username', password = 'password')
  )

## End(Not run)

## Not run: 
  # message: "The credentials have been set."
  khis_cred(username = 'username', password = 'password')

  # suppress messages for a in a specific scope
  local_cancerscreening_quiet()

  # no message
  khis_cred(username = 'username', password = 'password')

  # clear credentials
  khis_cred_clear()

## End(Not run)