REDCap Plugin, Hook, & External Module Documentation

The code block below illustrates how one might use # and // as comments in your logic and calculations.

# Text can be put here to explain what the logic/calculation does and why.
if ([field1] = '1' and [field2] > 7,

	// This comment can explain what the next line does.
	[score] * [factor],

	// Return '0' if the condition is False.
	0
)

Working …

This value you provided is not a number. Please try again.

This value you provided is not an integer. Please try again.

The value entered is not a valid Vanderbilt Medical Record Number (i.e. 4- to 9-digit number, excluding leading zeros). Please try again.

The value you provided must be within the suggested range

The value you provided is outside the suggested range

This value is admissible, but you may wish to double check it.

The value entered must be a time value in the following format HH:MM within the range 00:00-23:59 (e.g., 04:32 or 23:19).

This field must be a 5 or 9 digit U.S. ZIP Code (like 94043). Please re-enter it now.

This field must be a 10 digit U.S. phone number (like 415 555 1212). Please re-enter it now.

This field must be a valid email address (like joe@user.com). Please re-enter it now.

The value you provided could not be validated because it does not follow the expected format. Please try again.

Required format:

REDCap Developer Tools:
Documentation for Plugins, Hooks, & External Modules

REDCap Version 14.9.1

REDCap::isLongitudinal

(REDCap >= 5.5.0)

REDCap::isLongitudinal — Finds whether the current project is longitudinal

Description

bool REDCap::isLongitudinal ( void )

Finds whether the current project has longitudinal data collection enabled and also has at least two events defined.

Return Values

Returns TRUE if project is longitudinal, FALSE otherwise.

Restrictions

This method can ONLY be used in a project context (i.e. when "pid" parameter is in the query string of the plugin URL) or else a fatal error is produced.

Examples

Example #1:

This example shows how one might perform a specific action if the project is longitudinal.

// Determine if project is longitudinal
if (REDCap::isLongitudinal()) {
    // Longitudinal project

} else {
    // Classic project

}

Plugins, Hooks, & External Modules

Developer methods for
Plugins, Hooks, & External Modules

Hook functions

REDCap Developer Tools:
Documentation for Plugins, Hooks, & External Modules

REDCap Version 14.9.1

Plugins, Hooks, & External Modules

Developer methods forPlugins, Hooks, & External Modules

Hook functions

REDCap Developer Tools:Documentation for Plugins, Hooks, & External Modules

REDCap Version 14.9.1

Developer methods for
Plugins, Hooks, & External Modules

REDCap Developer Tools:
Documentation for Plugins, Hooks, & External Modules