process_hyfe_data: Process a 'hyfe_data' object for plotting/analysis

In hyfe-ai/hyfer: R Utilities for Interacting with Hyfe Data

Description

This function converts a raw hyfe_data object into a polished hyfe object. This function is usually the first step after downloading data.

Usage

process_hyfe_data(hyfe_data, by_user = FALSE, verbose = TRUE)

Arguments

hyfe_data	A standard hyfe_data object downloaded from the Research Dashboard (for external partners) or from hyferdrive (internal analysts). See full details and examples in the package vignette.
by_user	Should data be processed in bulk, or for each user separately? Processing in bulk (by_user = FALSE, the default) can be quicker and makes summary plots easier (e.g., grand total monitoring hours across the cohort). Processing for each user separately (by_user = TRUE) can take more time at this stage, but opens up more possibilities for plotting and is necessary for unbiased metrics in which each user is given equal weight (e.g., mean cough rate across the cohort).
verbose	Print status updates?

Value

A hyfe object, which is a list with several named slots. See full details and examples in the package vignette.

hyfe-ai/hyfer documentation built on Dec. 20, 2021, 5:53 p.m.