Skip to content

ActiPASS project folder structure

Jump to bottom
Pasan Hettiarachchi edited this page Jun 5, 2024 · 34 revisions

ActiPASS project folder structure

Project-folder-structure

1) BatchOut

This folder contains various quality-check files and logs relevant to each batch. Within BatchOut, Each batch has its own separate folder in the form "yyyy-MM-dd HH.mm.ss". Inside these batch folders, the batch-configuration, the batch quality-check-table, quality-check-visualizations, event-diary for each individual and batch-execution-log are stored.

  1. The quality check visualizations (in the form "SubjectID-QC-#.png") summarizes settings, warnings and Activity/postures/diary visualizations into one figure and are very useful tool in visual quality checking an ActiPASS batch process (see example quality-check figure).

    • Tip! - One can easily perform the quality check of your data by quickly browsing these files by using the preview function of Windows File Explorer.

  2. The batch-quality-check table "ActiPASS_BatchQC.csv" stores various quality-check flags and other metadata related to each accelerometer data file. It contains information such as start/stop times of the measurement, start/stop times of the wear period, auto detected orientations, automatic individual calibration (reference positions), device calibration, outlier flags and other error flags.

  3. The batch-configuration file "ActiPASS_BatchSettings.txt" contains information about all settings and parameters which were used for the actual batch-processing. If you have forgotten settings used when you processed a batch, you can find those in this file.

  4. The file "ActiPASS_BatchLog.txt" contains the batch execution log.

2) CrashLogs

Here you can find crash logs with information that may be useful for the developer if something went wrong when running ActiPASS.

3) IndividualOut

Here the intermediate results from ActiPASS batch-processes are stored in separate folders for each individual.

In each individual folder:

  • If you have chosen to create "full" visualizations there are individual weekly histograms and pie-charts visualizations as well as weekly activity visualizations that can be used for feedback to the participants.
  • In each folder there is also a matlab data table with the activities, stepping cadence and diary-interval-data at 1s epochs.
  • A text warnings file contains errors and warnings which have been generated during the processing of the individual data.
  • There is also more specific information from the sleep/bedtime algorithm and daily activity that are available here.
  • These files should only be used for quality-checks or preliminary analyses. For final results proceed to stats-generation.

4) QC_Distributions

Here you find the distributions in histograms (*.png files) for each activity types. These distributions is valuable to use when you perform you quality check and shall find eventual outliers in your data. In the excel files the participants ID is shown.

Tips!- by opening the SubjectID_ Distributions.xls file in excel you can zoom out in excel and then you can visualize an upside down histogram with the participant ID's.

5) ActiPASS_QC_MasterFile.xlsx

This file contains data merged from all batch-quality-check tables (see above) which is used as a master quality check table. It contains information such as start/stop times of the measurement, start/stop times of the wear period, orientation, automatic individual calibration (reference positions), device calibration, outlier flags and other error flags. If needed make changes to "QC_Status" column of this master QC-Table. This column will be considered for exclusion criteria in the final stats generation.

6) ActiPASS_Daily_LongFormat_MasterFile.csv

This is the main result file which contains merged data from one or several batches separated into calendar days. The file contains all default variables which are needed for most types of analysis. This is a long-format (i.e. multiple rows for each day for each participant) table and contain data for both valid and invalid (not enough wear-time and other exclusions) days. It also contains columns of quality-check information for each day. For more information about the variable definitions we refer to ActiPASS variable dictionary. The file is created after the stat generation step in ActiPASS.

7) ProPASS_WideFormat_MasterFile.csv

This file also contains calendar day based variables from all batches (similar to the above) suitable for ProPASS projects. This is a wide-format table (i.e. there is only row for each participant). However this table only contains data for only first valid 7 days (ProPASS criteria). For more information about the variable definitions please refer ActiPASS variable dictionary. This file is created after stat generation step in ActiPASS.

8) ActiPASS_Events_LongFormat_MasterFile.csv

This is the results of an events (stats-domains) based stats generation. This is generated only when ActiPASS output table format is changed from default "daily" format to one of the "Events" formats in advanced settings. Unlike 'days', 'events' are not automatically quality checked for validity, and this table contains all events sequentially as a long format table.

Clone this wiki locally