https://github.com/fredhutch/redcapdotnetdets

Data entry triggers for REDCap written using .NET Web API
https://github.com/fredhutch/redcapdotnetdets

redcap redcap-api

Last synced: 23 days ago
JSON representation

Data entry triggers for REDCap written using .NET Web API

• Host: GitHub
• URL: https://github.com/fredhutch/redcapdotnetdets
• Owner: FredHutch
• License: apache-2.0
• Created: 2016-07-26T14:41:22.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-06-22T18:01:53.000Z (over 2 years ago)
• Last Synced: 2024-04-16T04:30:13.563Z (8 months ago)
• Topics: redcap, redcap-api
• Language: C#
• Homepage:
• Size: 404 KB
• Stars: 7
• Watchers: 9
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# REDCapDotNetDETs

> Created by Paul Litwin, [Collaborative Data Services](http://cds.fredhutch.org), Fred Hutchinson Cancer Reseach Center, Seattle

## Description

A Microsoft .NET-based implementation of a set of [REDCap](https://projectredcap.org) Data Entry Triggers.

- Created with Visual Studio 2015.

- .NET version: 4.5.2.

- Built as an ASP.NET WebAPI web service using C# programing language.

- Uses Log4Net for logging.

- Includes unit test for Adaptive randomization code.

- Extensive comments in source code.

### Update History

- See GitHub releases.

### This solution contains two projects

- **DotNetDETs** - This is the main project containing three WebAPI endpoints: 

  - **DETExample** - a basic example of a .NET data entry trigger. Implemented using class  DotNetDETs/Controllers/DETExampleController.cs.

  - **Adaptive** - a .NET data entry trigger that implements **Adaptive Randomization** in REDCap. Implemented using class  DotNetDETs/Controllers/AdaptiveController.cs.

  - **DatabasedNotify** - a .NET data entry trigger that reacts to a saved survey and then, based on the value

of a field on the survey, adds the record to the appropriate data access group and emails the

appropriate site contact.

- **DotNetDETUnitTests** - This is a unit test project for testing the Adaptive Randomization code.

A description of each of the endpoints and supporting code follows...

## DETExample Endpoint

This is basic example of a data entry trigger built in asp.net as a WebAPI web service. It uses common code (see below).

## Adaptive Endpoint

This REDCap DET implements Adaptive Randomization per Smoak and Lin 

.

One difference from the Smoak and Lin paper is that there is no run-in of simple randomization as mentioned in the paper. Instead, only the first assignment for each covariate group is randomly assigned using simple randomization. Thereafter, all subjects in that group are randomized using adaptive randomization.

### REDCap Hook used to integrate Adaptive Randomization into data form

Here is the hook code used to create a **Randomize Participant** button on our randomization form which mimics the Save and Continue button on a REDCap form. It uses the [Andy Martin REDCap Hook Framework](https://github.com/123andy/redcap-hook-framework). *This PHP code shown here is not included in the source of this .NET project.*

```

$(function() {$("input[name=\'pc_rnd_ready\']").replaceWith(""); });';

			break;

        default:

		//nothing to do

	

	}

?>

```

### Unit Test for the Adaptive randomization code

The DotNetDETUnitTests unit test project allows you to quickly randomize a bunch of subjects to see if the adaptive randomization routine is working properly.

## DatabasedNotify Endpoint

Performs two actions based on the value of the *cityField* field:

 1. Adds form to appropriate data access group (DAG) based on city.

 2. Notifies appropriate contact at the site for that city.

Note: The *DatabasedNotifyEmailsTestMode* config setting of true diverts all emails to 

test recipient. Need to set to false when in production.

## Common Code

The common code under the Infrastructure folder consists of the following classes:

 1. **RedCapDETBModelBinder.cs** is used to parse the posted values passed to the DET by REDCap. 

 2. **RedCapAccess.cs** contains routines to read and write records to REDCap. The REDCap API code was adapted from the work of [Chris Nefcy](https://github.com/redcap-tools/nef-c-sharp).

 3. **Metadata.cs** is a class used to store the metadata (data dictionary) from the ExportMetadata API call.

 4. **Messaging.cs** is used to send asynchronous emails.