Functions to access Deep probe values
Deep probe functions allow you to use Deep probe values in reports, specifically within Deep probe operations and weighting setup.
deepProbe
Returns the Deep probe output result for each participant with the following types:
- Strings will remain strings.
- Numbers will remain numbers.
- Categories will be returned as strings (the category label).
- Undefined values will remain
undefined. - Not calculated values will be returned as
undefined.
Usage: deepProbe(deep_probe_id), where deep_probe_id is the ID of the selected Deep probe.
Example: deepProbe(12345)
deepProbeExists
Returns:
TRUEif the Deep probe output was calculated for the participant (even if it’s undefined).FALSEif the Deep probe output was not calculated for the participant.
Usage: deepProbeExists(deep_probe_id), where deep_probe_id is the ID of the selected Deep probe.
Example: deepProbeExists(12345)
deepProbeType
This function returns the data type of the Deep probe output as a string (e.g., "string", "number", "category"), 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.
Example: deepProbeType(12345)
Examples
The following examples shows how what values these functions will return:
| Participant | Output of Deep probe 12345 | What deepProbe(12345) returns | What deepProbeExists(12345) returns | What deepProbeType(12345) returns |
|---|---|---|---|---|
| 1 | "Very likely" (string) | "Very likely" (string) | TRUE | "string" (string) |
| 2 | 15 (number) | 15 (number) | TRUE | "number" (string) |
| 3 | "Cats" (category) | "Cats" (string) | TRUE | "category" (string) |
| 4 | "FALSE" (category) | "FALSE" (string) | TRUE | "category" (string) |
| 5 | undefined | undefined | TRUE | "undefined" (string) |
| 6 | (Not calculated) | undefined | FALSE | "undefined" (string) |