Create a rescomp parameter using a sine/square/triangle wave

Produces an object suitable to include in a rescomp_param_list. Triangle and square waves are phase-shifted to be similiar in shape to a sine wave with the same period and offset, such that the peaks and troughs occur in the same places.

rescomp_param_sine(period = 1, min = 0, max = 1, offset = 0)

rescomp_param_triangle(period = 1, min = 0, max = 1, offset = 0)

rescomp_param_square(period = 1, min = 0, max = 1, offset = 0)

Arguments

period

The period of the wave.

min

The minimum value of the parameter; the mean minus the amplitude.

max

The maximum value of the parameter; the mean plus the amplitude.

offset

The phase shift of the wave. For a sine or triangle wave the time at which its value is equal to the mean. For a square wave, the time at which it increases to the maximum value.

display_values

A numeric vector of values of the parameter to use in plot_funcresp().

Value

S3 object of class rescomp_param.

Examples

# TODO