saturation_hill: Hill Saturation Transformation

View source: R/transformation.R

saturation_hillR Documentation

Hill Saturation Transformation

Description

saturation_hill is a two-parametric version of the Hill function that allows the saturation curve to flip between S and C shape.

Produce example plots for the Hill saturation curve.

Usage

saturation_hill(x, alpha, gamma, x_marginal = NULL)

plot_saturation(plot = TRUE)

Arguments

x

Numeric vector.

alpha

Numeric. Alpha controls the shape of the saturation curve. The larger the alpha, the more S-shape. The smaller, the more C-shape.

gamma

Numeric. Gamma controls the inflexion point of the saturation curve. The larger the gamma, the later the inflexion point occurs.

x_marginal

Numeric. When provided, the function returns the Hill-transformed value of the x_marginal input.

plot

Boolean. Do you wish to return the plot?

Value

Numeric values. Transformed values.

See Also

Other Transformations: adstock_geometric(), mic_men()

Examples

saturation_hill(c(100, 150, 170, 190, 200), alpha = 3, gamma = 0.5)

Robyn documentation built on June 27, 2024, 9:06 a.m.