https://github.com/ctsit/warrior_specific_features

This is a redcap modules which contains specific features for warrior project.
https://github.com/ctsit/warrior_specific_features

redcap redcap-external-module

Last synced: 2 months ago
JSON representation

This is a redcap modules which contains specific features for warrior project.

• Host: GitHub
• URL: https://github.com/ctsit/warrior_specific_features
• Owner: ctsit
• License: other
• Created: 2017-11-16T15:18:24.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-03-03T20:28:46.000Z (almost 4 years ago)
• Last Synced: 2023-08-19T18:13:23.405Z (over 1 year ago)
• Topics: redcap, redcap-external-module
• Language: PHP
• Size: 44.9 KB
• Stars: 1
• Watchers: 7
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# WARRIOR Project Specific Features

This is REDCap module provides specific features for the Warrior project.

## Prerequisites

- REDCap >= 8.0.3 (for versions < 8.0.3, [REDCap Modules](https://github.com/vanderbilt/redcap-external-modules) is required).

## Installation

- Clone this repo into to `/modules/warrior_specific_features_v`.

- Go to **Control Center > Manage External Modules** and enable Linear Data Entry Workflow.

- For each project you want to use this module, go to the project home page, click on **Manage External Modules** link, and then enable Warrior Specific Features for that project.

## Features included

### @SUBJECT-ID action tag

A new action tag is provided: `@SUBJECT-ID`, which automatically:

- Sets the target field as read only

- Sets a subject ID value to the target field in the following format: `-`, e.g. for `2-12`, `WAR` as prefix, as record ID, `John` as first name, and `Smith` as last name, the result will be `WAR02-JS012`.

Obs.: Note that dag ID is zero-padded to 2 digits, and record ID is zero-padded to 3 digits.

#### Configuration

By default, Automatic Subject ID looks for `first_name` and `last_name` fields, and take `WAR` prefix. If your source fields are named differently or if you need to change the prefix, go to  **Manage External Modules** section of your project, select Warrior Specific Feature to configure, and then fill out _Automatic subject ID_ section.

#### Note

- If the DAG ID does not exist, then the DAG prefix will be ignored - e.g. the subject ID would be `JS012` instead of `WAR02-JS101`

- Given name and surname values must be saved prior to subject ID field, i.e. these fields should be placed in instruments that will be filled before subject ID field. You can force users to a linear workflow by installing [Linear Data Entry Workflow module](https://github.com/ctsit/linear_data_entry_workflow)

### @DATE-MAX action Tag

A new action tag is provided: `@DATE-MAX`, which takes the maximum date from a bunch of date fields (across all events), and saves it into a field. How it works:

- The tagged field must be configured as a date in `Y-M-D` format.

- Once a field is tagged as `@DATE-MAX`, it will be hidden to end-users.

- A name prefix must be provided as argument in order to group the target fields. Example: `@DATE-MAX=date_example_` will extract the maximum from fields like `date_example_foo`, `date_example_bar`, etc.

- Every time a target field is updated, the maximum value is recalculated and saved again, no matter if the tagged field is in the current form.

- If the tagged field is present in multiple events, the maximum value is only stored in the first one. It means that the first event should be always referenced for Piping purposes (e.g. `[event_1_arm_1][max_date_example]`).