https://github.com/lsgs/redcap-event-navigation-tweaks

REDCap external module with enhancements to event and arm navigation.
https://github.com/lsgs/redcap-event-navigation-tweaks

mcri murdoch-childrens redcap redcap-external-module redcap-repo

Last synced: 5 months ago
JSON representation

REDCap external module with enhancements to event and arm navigation.

• Host: GitHub
• URL: https://github.com/lsgs/redcap-event-navigation-tweaks
• Owner: lsgs
• License: gpl-3.0
• Created: 2020-02-24T03:01:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-19T07:39:52.000Z (almost 2 years ago)
• Last Synced: 2024-08-19T08:59:50.453Z (almost 2 years ago)
• Topics: mcri, murdoch-childrens, redcap, redcap-external-module, redcap-repo
• Language: PHP
• Homepage:
• Size: 302 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# REDCap External Module: Event Navigation Tweaks

## Description

Provides enhancements to navigation of events and arms on data entry forms, the "Add / Edit Records" page, the "Record Status Dashboard" page, and "Record Home" page.

View [GitHub repository](https://github.com/lsgs/redcap-event-navigation-tweaks).

## Features

Each feature must be enabled separately in the module configuration dialog. 

### 1. Data Entry Form event display

Clicking "Change" by the event name display on a data entry form raises a popover displaying navigation links to the first form and current form (where applicable) in other events.

![DE form event nav example](./img/formeventnav.png)

In a multi-arm project, events are shown only for arms where the record exists (i.e. has data entered for at least one event in the arm).

### 2. Record Home Page Arm Navigation 

In multi-arm projects:

* The "Notice: record X exists on another arm." message is suppressed. 

* Switch to Record Home Page for current record in other arms (where new data can be added, hence record created). 

![Record Home page](./img/rechomepage.png)

This option has no effect in single-arm projects.

### 3. Designate First Arm as Primary Arm

Designate the first arm of a multi-arm project as the "primary arm". The Add / Edit Records and Record Status Dashboard pages restrict the creation of new records to the primary arm only (although it will be still possible via import or direct URL access). Records can be added to other arms via the Record Home page.

#### Add / Edit Records Page

Arm-selection dropdown lists are hidden so records can be selected and created in the first arm only.

![Add/Edit Records page](./img/addeditpage.png)

#### Record Status Dashboard Page

Create record option only shown when viewing the primary arm instead of for any arm.

![Dashboard page](./img/rsdpage.png)

This option has no effect in single-arm projects.

### 4. Control of Arm Visibility

#### Arms Available by Default

Select an arm or arms to be available by default for records. 

#### Utilise Field Data to Control Arm Visibility

Indicate event(s) and field(s) that contain arm numbers, or comma-separated lists of arm numbers that are available for the current record to be added to.

* Where specifying a text/`@CALCTEXT` field a dynamic comma-separated list of arms is supported. e.g. `"2,4,5"`, as might be given by:

  `@CALCTEXT(if(,'comma-delimited-list-of-arms-when-TRUE','comma-delimited-list-of-arms-when-FALSE'))`

* Specification of arms across multiple fields here is cumulative.

* If the option "Make first arm the primary arm?" is selected, the first arm will be displayed even when not included in the field's list.