Package 'adverbial'

Wrap a function to be used as a step

Description

Usage

as_step(f, name = NULL)

Arguments

f	A function to be wrapped.
name	The name of the step. If NULL, the step does not proceed but the function is applied.

Details

as_step() wraps a function to be used as a step in a step-by-step process.

Value

A function that takes a step-by-step object and additional arguments, and returns the updated step-by-step object.

---

End a step-by-step process

Description

Usage

end_step(object)

Arguments

object

The object to end the step-by-step process for.

Details

end_step() ends the step-by-step process and removes the step-by-step attributes from the object.

Value

The object with the step-by-step attributes removed.

---

Create composed functions

Description

Create composed functions

Usage

new_composed(fns, dir = NULL, ..., class = character())

Arguments

fns	A list of functions to compose.
dir	Direction of composition, either "forward" or "backward". By default, the functions are composed in the forward direction. Passed to purrr::compose().
...	Additional arguments for attributes.
class	Name of subclass.

Value

A composed function that inherits from adverbial_function_compose.

See Also

purrr::compose()

Examples

square <- function(x) x ^ 2
cdist <- new_composed(list(square = square, sum = sum, sqrt = sqrt))
cdist(1:10)

cdist$sum <- new_partialised(sum, list(na.rm = TRUE))
cdist(c(1:10, NA))

---

Create partialised functions

Description

Create partialised functions

Usage

new_partialised(f, args, ..., class = character())

Arguments

f	A function.
args	A list of default arguments.
...	Additional arguments for attributes.
class	Name of subclass.

Value

A adverbial_function_partial function.

See Also

purrr::partial()

Examples

dist <- function(x, y) {
  sqrt(x ^ 2 + y ^ 2)
}
pdist <- new_partialised(dist, list(x = 3))
pdist(y = 4)

---

Create a step-by-step object

Description

Usage

step_by_step(steps)

Arguments

steps

A named vector of steps to be completed. The names of the vector are the names of the steps, and the values are the descriptions of the steps.

Details

step_by_step() creates a step-by-step object that can be used to track the progress of a process. It is useful for long-running processes where you want to keep track of the steps that have been completed and the steps that are still to be done.

Value

A function that takes an object and returns a step-by-step object.

---