datagathering - eisclimber/ExPresS-XR GitHub Wiki

ExPresSXR.Experimentation.DataGathering Namespace

Summary

Classes for gathering data.

Attributes

Name Description
HeaderReplacementAttribute Helper attribute for header replacements with multi Columns.
The header-fields can be provided as individual parameters for the annotation.
HeaderReplacementNoticeAttribute Helper attribute for header replacement notifications with multi Columns.
MultiColumnValueAttribute Helper attribute to annotate multi Columns.

Classes

Name Description
AttributeHelpers A class containing various helpers for using custom attributes.
CsvUtility Utility functions any values for CSV serialization, internally used by the DataGatherer.
DataGatherer The Data Gatherer is a component to extract and save data in a Unity Scene.
All values that are specified in the Data Gatherer will be stored in a CSV-formatted file which will be saved at the path and/or be send via http POST to a server.

A more detailed description of the capabilities of the Data Gatherer can be found in the DataGathering-Tutorial which is also available in the editor under "ExPresS XR > Data Gathering".

Some important things to note:

  • The DataGatherer can automatically export values but any script can export new values at any time callingExportNewCsvLine().
  • When played in the editor the Values will be stored at Application.dataPath. The Build will store it at the apps data-path (e.g. %APPDATA% on Windows)
  • While includeTimestamp is optional it is recommended to include it as the export times might differ by a few milliseconds.
  • The shortest somewhat stable value for periodicExportTime was about 0.01s.
  • Using exportDuringUpdate the exports were around 0.02 on a Valve Index (aprox. Time.DeltaTime with 60FPs).| |DataGatheringBinding|A class to represent a binding of a value from some GameObject's Component to be used by DataGatherer.

The values can be either return values of public functions or public members. Using reflections these values will automatically be read when data is required to be exported.| |DataGatheringHelpers|Utility functions for data gathering.| |QuizRoundData|A data wrapper for exporting relevant data when answering the relevant data after answering a button quiz question.|

⚠️ **GitHub.com Fallback** ⚠️