Deep Probe functions
Deep probe functions allow you to use Deep probe values in reports, specifically within Deep probe operations and weighting setup.
The available functions depend on the context in which they’re used:
- When used in Deep probe: The
deepProbe,deepProbeExists, anddeepProbeTypeare available. - When used in weighting with a continuous scheme: Only
deepProbeanddeepProbeExistsfunctions are available. In this weighting context, any value returned by these functions is automatically converted to a number (numeric data type).
All these functions return a Deep probe-related value for each participant.
deepProbe
Returns the Deep probe output result for each participant. When used in Deep probe, the return value is converted to a string data type.
When used in weighting, the return value is converted to a numeric data type. If the conversion is not possible or the return value is undefined, it returns 0.
Usage: deepProbe({deep_probe_id}), where deep_probe_id is the ID of the selected Deep probe.
Examples:
deepProbe(12345)
The following example shows how deepProbe(12345) returns values for different participants based on the Deep probe output data type and usage context:
| Participant | Deep probe 12345 output | When used in Deep probe | When used in weighting |
|---|---|---|---|
| Participant 1 | "Very likely" (string) | "Very likely" (string) | 0 (number) |
| Participant 2 | 15 (number) | "15" (string) | 15 (number) |
| Participant 3 | "Cats" (category) | "Cats" (string) | 0 (number) |
| Participant 4 | FALSE (boolean) | "false" (string) | 0 (number) |
| Participant 5 | Undefined | undefined | 0 (number) |
| Participant 6 | (Not calculated) | undefined | 0 (number) |
deepProbeExists
When used in Deep probe, returns TRUE if the Deep probe output was calculated for the participant, or FALSE if it was not calculated or is undefined.
When used in weighting, Returns 1 if the function returns TRUE, or 0 if the function returns FALSE.
Usage: deepProbeExists({deep_probe_id}), where deep_probe_id is the ID of the selected Deep probe.
Examples:
deepProbeExists(12345)
The following example shows how deepProbeExists(12345) returns values for different participants based on the Deep probe output data type and usage context:
| Participant | Deep probe 12345 output | When used in Deep probe | When used in weighting |
|---|---|---|---|
| Participant 1 | "Very likely" (string) | TRUE | 1 |
| Participant 2 | 15 (number) | TRUE | 1 |
| Participant 3 | "Cats" (category) | TRUE | 1 |
| Participant 4 | FALSE (boolean) | TRUE | 1 |
| Participant 5 | Undefined | FALSE | 0 |
| Participant 6 | Not calculated | FALSE | 0 |
deepProbeType
This function is only available in Deep probe. It returns the data type of the Deep probe output as a string (e.g., "string", "number", "category", "boolean"), or "undefined" if the output was not calculated or is undefined.
Usage: deepProbeType({deep_probe_id}), where deep_probe_id is the ID of the selected Deep probe.
Examples:
deepProbeType(12345)
The following example shows how deepProbeType(12345) returns values for different participants based on the Deep probe output data type:
| Participant | Deep probe 12345 output | When used in Deep probe |
|---|---|---|
| Participant 1 | "Very likely" (string) | "string" (string) |
| Participant 2 | 15 (number) | "number" (string) |
| Participant 3 | "Cats" (category) | "category" (string) |
| Participant 4 | FALSE (boolean) | "boolean" (string) |
| Participant 5 | Undefined | "undefined" (string) |
| Participant 6 | Not calculated | "undefined" (string) |