hyfe_timetables: Produce summary tables of Hyfe data (hourly, daily, weekly)

Description Usage Arguments Value

View source: R/hyfe_timetables.R

Description

This is a background utility function not usually used by analysts directly.

Usage

1
2
3
4
5
6
7
hyfe_timetables(
  hyfe_data,
  tz = NULL,
  timestamp_start = NULL,
  timestamp_stop = NULL,
  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.

tz

If NULL (the default), this function will look within the cohort_settings slot of the hyfe_data object for the timezone to use. If not found there, the assumption will be UTC.

timestamp_start

If you want to specify the beginning of the time table, enter timestamp here.

timestamp_stop

Specify end of timetable, if you want.

verbose

Print status updates?

Value

A list of tables summarizing monitoring/cough data into timeseries with the units hours, days, and weeks. See [the vignette for full details)https://hyfe-ai.github.io/hyfer/#timetables. Note that this function lumps all users together.


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