Merge pull request #156 from RADAR-base/release-0.4.3

Release 0.4.3

README.md

@@ -1,8 +1,8 @@
 # RADAR-Schemas
 
-[![Build Status](https://travis-ci.org/RADAR-CNS/RADAR-Schemas.svg?branch=master)](https://travis-ci.org/RADAR-CNS/RADAR-Schemas)
+[![Build Status](https://travis-ci.org/RADAR-base/RADAR-Schemas.svg?branch=master)](https://travis-ci.org/RADAR-base/RADAR-Schemas)
 
-[Avro schemas](https://avro.apache.org/docs/1.8.2/spec.html) used in RADAR-CNS. The schemas are organized as follows:
+[Avro schemas](https://avro.apache.org/docs/1.8.2/spec.html) used in RADAR-base. The schemas are organized as follows:
 
 - The `commons` directory contains all schemas used inside Kafka and data fed into Kafka.
   - In the `active` subdirectory, add schemas for active data collection, like questionnaires or assignments.
@@ -35,7 +35,7 @@ In addition, schemas in the `commons` directory should follow the following guid
 
 ### Validation phase
 
-Avro schemas are automatically validated against RADAR-CNS guide lines while building. For more details, check [catalog validator](java-sdk/radar-schemas-tools).
+Avro schemas are automatically validated against RADAR-base guide lines while building. For more details, check [catalog validator](java-sdk/radar-schemas-tools).
 
 ### Test setup
 

commons/active/notification/notification.avsc

@@ -2,7 +2,7 @@
   "namespace": "org.radarcns.active.notification",
   "type": "record",
   "name": "Notification",
-  "doc": "General schema for notifications. Check the specification folder to see how the notification has been defined. For each NotificationType there is a JSON file reporting the questions set and possible answers if available.",
+  "doc": "NOTE: THIS SCHEMA IS DEPRACATED. PLEASE USE org.radarcns.active.questionnaire.Questionnaire. General schema for notifications. Check the specification folder to see how the notification has been defined. For each NotificationType there is a JSON file reporting the questions set and possible answers if available.",
   "fields": [
     { "name": "time", "type": "double", "doc": "Timestamp in UTC (s) when the notification is submitted to the subject." },
     { "name": "timeCompleted", "type": "double", "doc": "Timestamp in UTC (s) when subject marks the notification as complete." },

commons/active/opensmile/open_smile_2_audio_analysis.avsc

@@ -6,6 +6,7 @@
   "fields": [
     {"name": "time", "type": "double", "doc": "Device timestamp in UTC (s)."},
     { "name": "timeCompleted", "type": "double", "doc": "Timestamp in UTC (s) when subject completed the audio questionnaire." },
+    { "name": "timeNotification", "type": ["null", "double"], "doc": "Timestamp in UTC (s) when the notification to complete the questionnaire is sent.", "default": null },
     {"name": "config", "type": "string", "doc": "Contents of an OpenSMILE configuration file." },
     {"name": "data", "type": ["null", "string"], "doc": "Audio features computed by openSMILE in plain text.", "default": null},
     { "name": "reciteText", "type": ["null", "string"], "doc": "Text that was supposed to be recited as part of the recording.", "default": null }

commons/active/opensmile/open_smile_2_audio_recording.avsc

@@ -6,6 +6,7 @@
   "fields": [
     { "name": "time", "type": "double", "doc": "Device timestamp when the audio recording was started (s since the Unix Epoch)." },
     { "name": "timeCompleted", "type": "double", "doc": "Device timestamp when the audio recording was completed (s since the Unix Epoch)." },
+    { "name": "timeNotification", "type": ["null", "double"], "doc": "Timestamp in UTC (s) when the notification to complete the questionnaire is sent.", "default": null },
     { "name": "mediaType", "type": "string", "doc": "Media type of the audio recording format. For example, audio/wav for a WAV recording. See https://www.iana.org/assignments/media-types/media-types.xhtml#audio for the list of standardized audio media types."},
     { "name": "data", "type": "string", "doc": "Base64 encoded contents of the recorded audio file." },
     { "name": "reciteText", "type": ["null", "string"], "doc": "Text that was supposed to be recited as part of the recording.", "default": null }

commons/monitor/application/application_device_info.avsc

@@ -0,0 +1,21 @@
+{
+  "namespace": "org.radarcns.monitor.application",
+  "type": "record",
+  "name": "ApplicationDeviceInfo",
+  "doc": "Device information where the application is running.",
+  "fields": [
+    { "name": "time", "type": "double", "doc": "Device timestamp as time since the Unix Epoch (s)." },
+    { "name": "manufacturer", "type": ["null", "string"], "doc": "Manufacturer of the device. Null if unknown.", "default": null },
+    { "name": "model", "type": ["null", "string"], "doc": "Model of the device. Null if unknown.", "default": null },
+    { "name": "operatingSystem", "type": {
+      "name": "OperatingSystem",
+      "type": "enum",
+      "symbols": ["ANDROID", "IOS", "MACOS", "WINDOWS", "LINUX", "BSD", "OTHER", "UNKNOWN"],
+      "doc": "Operating system types."
+      }, "doc": "Operating system that the application is running on.", "default": "UNKNOWN"},
+    { "name": "operatingSystemVersion", "type": ["null", "string"], "doc": "Operating system version as readable string. Null if unknown.", "default": null },
+    { "name": "operatingSystemVersionCode", "type": ["null", "int"], "doc": "Operating system unique version number. Null if unknown.", "default": null },
+    { "name": "appVersion", "type": ["null", "string"], "doc": "App version as a readable string. Null if unknown.", "default": null },
+    { "name": "appVersionCode", "type": ["null", "int"], "doc": "Unique app version number. Null if unknown.", "default": null }
+  ]
+}

java-sdk/README.md

@@ -9,10 +9,10 @@ repositories {
 
 dependencies {
     // Commons schemas (backend, passive remote monitoring app)
-    compile 'org.radarcns:radar-schemas-commons:0.4.2'
+    compile 'org.radarcns:radar-schemas-commons:0.4.3'
 
     // Questionnaire schemas (active remote monitoring app)
-    compile 'org.radarcns:radar-schemas-tools:0.4.2'
+    compile 'org.radarcns:radar-schemas-tools:0.4.3'
 }
 ```
 Usually, you only need to include the schemas you actually need in your dependencies.

java-sdk/build.gradle

@@ -4,8 +4,8 @@
 
 plugins {
     id 'com.commercehub.gradle.plugin.avro-base' version '0.9.0'
-    id 'com.jfrog.bintray' version '1.8.1'
-    id 'com.jfrog.artifactory' version '4.7.5'
+    id 'com.jfrog.bintray' version '1.8.4'
+    id 'com.jfrog.artifactory' version '4.8.1'
 }
 
 subprojects {
@@ -17,7 +17,7 @@ subprojects {
     apply plugin: 'idea'
 
     // Configuration
-    version = '0.4.2'
+    version = '0.4.3'
     group = 'org.radarcns'
     ext.githubRepoName = 'RADAR-base/RADAR-Schemas'
 

java-sdk/radar-schemas-tools/build.gradle

@@ -22,13 +22,13 @@ ext {
     description = 'RADAR Schemas specification and validation tools.'
 
     argparseVersion = '0.8.1'
-    jacksonVersion = '2.9.6'
+    jacksonVersion = '2.9.8'
     jerseyVersion = '2.27'
-    jettyVersion = '9.4.11.v20180605'
+    jettyVersion = '9.4.14.v20181114'
     junitVersion = '4.12'
-    kafkaVersion = '2.0.0'
-    okHttpVersion = '3.11.0'
-    radarCommonsVersion = '0.10.0'
+    kafkaVersion = '2.1.0'
+    okHttpVersion = '3.12.0'
+    radarCommonsVersion = '0.11.3'
     slf4jVersion = '1.7.25'
 }
 
@@ -53,7 +53,7 @@ dependencies {
 
     runtimeOnly group: 'org.glassfish.jersey.media', name: 'jersey-media-json-jackson', version: jerseyVersion
     runtimeOnly group: 'org.slf4j', name: 'slf4j-simple', version: slf4jVersion
-    runtimeOnly group: 'org.glassfish.jersey.inject', name: 'jersey-hk2', version: jerseyVersion 
+    runtimeOnly group: 'org.glassfish.jersey.inject', name: 'jersey-hk2', version: jerseyVersion
 
     testCompile group: 'junit', name: 'junit', version: junitVersion
 }

specifications/active/aRMT-1.4.2.yml

@@ -0,0 +1,57 @@
+name: aRMT
+vendor: RADAR
+model: aRMT-App
+version: 1.4.2
+assessment_type: QUESTIONNAIRE
+doc: aRMT Questionnaires definition. Includes Personal Health Questionnaire Depression Scale (PHQ-8), Experience sampling method (ESM) and RSES and other data.
+data:
+  - type: THINC-IT
+    topic: notification_thinc_it
+    value_schema: .active.questionnaire.Questionnaire
+    questionnaire_definition_url: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/thinc_it/thinc_it_armt.json
+  - type: ROMBERG_TEST
+    doc: The value of the task is in milliseconds (ms).
+    topic: task_romberg_test
+    value_schema: .active.task.Task
+    questionnaire_definition_url: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/romberg_test/romberg_test_armt.json
+  - type: 2MW_TEST
+    doc: The value of the task is in milliseconds (ms).
+    topic: task_2MW_test
+    value_schema: .active.task.Task
+    questionnaire_definition_url: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/2MW_test/2MW_test_armt.json
+  - type: TANDEM_WALKING_TEST
+    doc: The value of the task is in milliseconds (ms).
+    topic: task_tandem_walking_test
+    value_schema: .active.task.Task
+    questionnaire_definition_url: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/tandem_walking_test/tandem_walking_test_armt.json
+  - type: PHQ8
+    topic: questionnaire_phq8
+    value_schema: .active.questionnaire.Questionnaire
+    questionnaire_definition_url: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/phq8/phq8_armt.json
+  - type: ESM
+    topic: questionnaire_esm
+    value_schema: .active.questionnaire.Questionnaire
+    questionnaire_definition_url: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/esm/esm_armt.json
+  - type: AUDIO
+    topic: questionnaire_audio
+    value_schema: .active.opensmile.OpenSmile2AudioRecording
+  - type: RSES
+    topic: questionnaire_rses
+    value_schema: .active.questionnaire.Questionnaire
+    questionnaire_definition_url: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/rses/rses_armt.json
+  - type: PDQ
+    topic: questionnaire_perceived_deficits_questionnaire
+    value_schema: .active.questionnaire.Questionnaire
+    questionnaire_definition_url: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/perceived_deficits_questionnaire/perceived_deficits_questionnaire_armt.json
+  - type: PDDS
+    topic: questionnaire_patient_determined_disease_step
+    value_schema: .active.questionnaire.Questionnaire
+    questionnaire_definition_url: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/patient_determined_disease_step/patient_determined_disease_step_armt.json
+  - type: COMPLETION_LOG
+    doc: Information about the completeness of each questionnaire.
+    topic: questionnaire_completion_log
+    value_schema: .monitor.questionnaire.QuestionnaireCompletionLog
+  - type: TIMEZONE
+    doc: Timezone information sent along with each questionnaire.
+    topic: questionnaire_timezone
+    value_schema: .monitor.application.ApplicationTimeZone

specifications/monitor/radar_prmt-1.0.0.yml → specifications/monitor/radar_prmt-1.1.0.yml

@@ -1,7 +1,7 @@
 name: RADAR_pRMT
 vendor: RADAR
 model: pRMT
-version: 1.0.0
+version: 1.1.0
 doc: Status updates from the RADAR-CNS pRMT app.
 app_provider: .application.ApplicationServiceProvider
 data:
@@ -43,3 +43,10 @@ data:
     unit: SECOND
     topic: application_time_zone
     value_schema: .monitor.application.ApplicationTimeZone
+  - type: DEVICE_INFO
+    doc: Device information where the app is installed
+    sample_rate:
+      interval: 300
+      configurable: true
+    topic: application_device_info
+    value_schema: .monitor.application.ApplicationDeviceInfo