MyHeartCounts-StudyDefinitions

Overview

Study Definitions and supporting code for the My Heart Counts iOS application.

This package consists of 3 (three) targets:

• MHCStudyDefinition contains supporting code that is shared between the MHC app and the study definition, e.g., static properties defining custom active tasks;
• MHCStudyDefinitionExporter implements an export(to:) function that writes a study bundle archive to the file system;
• MHCStudyDefinitionExporterCLI is a CLI tool that calls export(to:) to export a study bundle archive.

Note that the package does not make the actual study definition available as an SPM package; this is intentional. Instead, the package only implements the code that exports the study bundle, in a format the MHC app can then download from a server and consume.

Testing and Study Defitition Integrity Validation

The swift test command may be used to run a dry-run export of the study definition, which will fail if the integrity verification step performed as part of the export finds any issues with the study definition (e.g., invalid references, invalid questionnaire definitions, etc).

The repo's CI setup performs this check on every push, to ensure that only valid study definitions can be merged.

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first. You can find a list of contributors in the CONTRIBUTORS.md file.

License

This project is licensed under the MIT License. See LICENSE.md for more information.

Citation

If you use this software, please cite it using the metadata in CITATION.cff, which GitHub surfaces through the Cite this repository button.

Our Research

For more information, visit the Schmiedmayer Lab GitHub organization.