Skip to content

TeachmanLab/mindtrails_movement

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MindTrails Movement

This repository contains the protocol for the Mind Trails Movement study, and all the code required to build the protocol from scratch.


Description of this Repo's Root Folders

  • 📁make -- Contains the CSV and Python scripts to "remake" the study surveys and sessions.
  • 📁validate -- Contains Python scripts to check if all Json is properly formatted
  • 📁src -- Contains the raw files that will be copied to device when a participant enrolls in the study

Downloading This Repo's Protocol in Digital Trails

This protocol can be downloaded in the Digital Trails app using the study code "MTM" on the initial startup screen.

image


Regenerating the JSON in This Repo's Protocol

All of the studie's custom content are described by JSON files. To recreate these files:

  1. Delete the folders in src/flows/ (note: you should only delete the folders).
  2. Run make/scripts/microdoses.py, make/scripts/surveys.py, and make/scripts/resources.py.
  3. Copy the folders generated by Step 2. The folders will be in the make/~out/ directory.
  4. Paste the output copied in Step 3 into src/flows

Releasing This Repo's Protocol to Digital Trails

Follow these steps to make protocol changes availalbe in Digital Trails.

  1. Desired protocol changes should be made in the src directory

  2. After finishing your changes commit them to this repository

  3. Once the desired changes have been committed and pushed to GitHub navigate to Releases image

  4. On the Releases page there will be a "Draft a New Release" in the top right

    image

  5. On the Release draft page: (a) enter a new "tag" to identify the release, (b) give it a title, and (c) click "Publish Release"

    image

  6. After publishing it will take about 2 minutes before the protocol will be ready to download in Digital Trails

  7. You can monitor the publish process by clicking on Action tab at the top.

    image

  8. In the Action tab, the publication process will appear at the top of the workflow list. Once the workflow is green it can be downloaded in Digital Trails.

    image


Releasing Multiple Versions of This Repo's Protocol

In addition to releasing a primary protocol (downloaded with MTM study code) it is also possible to release protcol versions. To do this:

  1. Create a new Release as described above, but this time be sure to unclick "Set as the latest release"

    image

  2. In Digital Trails enter your study code followed by an @ plus your release tag. For example, if your release tag was 1.0-beta you'd enter:

    image

  3. You can have as many release versions as you want, but only one "latest release". The "latest release" is always the default download.