-
Notifications
You must be signed in to change notification settings - Fork 183
Developer's Instrument Guide
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?
- An instrument should likely be coded manually in PHP if it involves:
- dependencies between fields
- special data formats or restricted types
- special scoring
- look-up tables (t-scores etc)
- age-dependencies in administering the instrument
- Has it been coded before? Current instruments list
#Developer Workflow ###Before getting started...
- Get the entire PDF or paper copy, including any “lookup” tables used for scoring/normalization.
- 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.
- How will all your fields map to the element types allowed by Loris form
- Does your instrument require certification? Are there certified examiners? Should users be certified as examiners for this instrument using the Training module?
###Get Started! 2. Create a new git branch based off the up-to-date branch for your project-specific repo. 3. Create an instrument in the project/instruments/ directory. 4. Insert the Instrument. 5. Front-end testing. 6. Push branch and create pull request to your project-specific repo. Assign relevant tags and tester. 7. Update any management documents and/or add a category to your bug tracker utility.
NEXT: (2) Create an instrument
See also: