Developer's Instrument Guide - aces/Loris GitHub Wiki

HOME > SETUP > DEVELOPER'S INSTRUMENT GUIDE

This guide reflects a typical workflow and best practices used by Loris developers at the MNI. Some specifics such as git workflow steps may not apply to all projects and implementations.

Should this instrument be coded? (PHP vs. LINST)

  1. An instrument should likely be coded manually in PHP if it involves:
  1. Has it been coded before? Current instruments list

Developer Workflow

Before getting started...

  1. Get the entire PDF or paper copy, including any “lookup” tables used for scoring/normalization.
  2. Find out: Which sections of the questionnaire should be included or omitted? Typically, administrative details included on the original form can be ignored, but instructions that will be helpful for the examiner might be included.
  3. Decide: How will all your fields map to the element types allowed by Loris form
  4. Find out: Does your instrument require certification? Are there certified examiners? Should users be certified as examiners for this instrument using the Examiner module?

Get Started!

  1. Create a new git branch based off the up-to-date branch for your project-specific repo.
  2. Create an instrument in the project/instruments/ directory.
  3. Insert the Instrument.
  4. Front-end testing.
  5. Push branch and create pull request to your project-specific repo. Assign relevant tags and tester.
  6. Update any management documents and/or add a category to your bug tracker utility.

NEXT: (2) Create an instrument

See also: