"No variant of function 'maxValue' consumes the parameters (Signal, Condition)" Error Occurs when using maxValue() to calculate the Maximum Value of a Signal within a Condition

[Dan FR]

User observes the error "No variant of function 'maxValue' consumes the parameters (Signal, Condition)" when using maxValue() to find the maximum value of a signal for each capsule in a condition?

Edited July 19 by Dan FR

[Dan FR]

Calculating the maximum value of a signal for each condition is a common analytics workflow performed in Seeq.

Users often start with the maxValue() function within the Seeq Formula Tool, but will run into challenges or errors. This is because the maxValue() function expects a single capsule ($capsule) as an input, as opposed to a condition, which is a collection of capsules.  If a user attempts to pass a $condition into maxValue() they will be met with the following error:

No variant of function 'maxValue' consumes the parameters (Signal, Condition)

Instead, the aggregate() function should be used when the intent is to find the maximum value for each capsule in a condition.  For example:

$signal.aggregate(maxValue(), $condition, durationkey())

This will create a signal indicating the maximum value for each capsule within $condition.  The durationkey() argument can be modified to the users liking for where to place the signal timestamp (startkey(), endkey(), etc).

Conversely, if a user wants to find the max value of a signal for a single capsule, they should first define the capsule using the capsule() function, and then apply maxValue(). For example:

$capsule = capsule('2024-07-19')

$signal.maxValue($capsule)