tic (version 0.4.0)

TicStep: The base class for all steps

Description

Override this class to create a new step.

Arguments

Methods

run

This method must be overridden, it is called when running the stage to which a step has been added.

prepare

This method is called when preparing the stage to which a step has been added. It auto-install all packages which are needed for a certain step. For example, step_build_pkgdown() requires the pkgdown package.

For add_code_step(), it autodetects any package calls in the form of pkg::fun and tries to install these packages from CRAN. If a steps prepare_call is not empty, the $prepare method is skipped for this step. This can be useful if a package should be installed from non-standard repositories, e.g. from Github.

check

This method determines if a step is prepared and run. Return FALSE if conditions for running this step are not met.

Methods

Public methods

Method new()

Usage

TicStep$new()

Method run()

Usage

TicStep$run()

Method prepare()

Usage

TicStep$prepare()

Method check()

Usage

TicStep$check()