flag_qc: Flag Quality Control Values

In muschellij2/SummarizedActigraphy: Coerce 'Actigraphy' to Summarized Experiments

Flag Quality Control Values

Description

Flag Quality Control Values

Usage

flag_qc(
  df,
  dynamic_range = NULL,
  verbose = TRUE,
  flags = c("all", "spike", "interval_jump", "spike_second", "same_value",
    "device_limit", "all_zero", "impossible")
)

flag_qc_all(
  df,
  dynamic_range = NULL,
  verbose = TRUE,
  flags = c("all", "spike", "interval_jump", "spike_second", "same_value",
    "device_limit", "all_zero", "impossible")
)

Arguments

df	A data set of actigraphy
dynamic_range	dynamic range of the device, used to find the device limit.
verbose	print diagnostic messages
flags	the flags to run for QC. If you set this to "all", then all flags are run, as the default.

Value

A data set with a 'flags' column ('flag_qc') or a number of columns starting with 'flag_*' ('flag_qc_all')

Examples

file = system.file("extdata", "TAS1H30182785_2019-09-17.gt3x",
package = "SummarizedActigraphy")
res = read_actigraphy(file)
out = flag_qc(res)

muschellij2/SummarizedActigraphy documentation built on Aug. 12, 2024, 5:35 p.m.