import_raw_activity_data {digiRhythm}R Documentation

Reads Raw Activity Data from csv files

Description

Reads Activity Data (data, time, activity(ies)) from a CSV file where we can skip some lines (usually representing the metadata) and select specific activities.

Usage

import_raw_activity_data(
  filename,
  skipLines = 0,
  act.cols.names = c("Date", "Time", "Motion Index", "Steps"),
  date_format = "%d.%m.%Y",
  time_format = "%H:%M:%S",
  sep = ",",
  original_tz = "CET",
  target_tz = "CET",
  sampling = 15,
  trim_first_day = TRUE,
  trim_middle_days = TRUE,
  trim_last_day = TRUE,
  verbose = FALSE
)

Arguments

filename

The file name (full or relative path with extension)

skipLines

The number of non-useful lines to skip (lines to header)

act.cols.names

A vector containing the names of columns to read (specific to the activity columns)

date_format

The POSIX format of the Date column (or first column)

time_format

The POSIX format of the Time column (or second column)

sep

The delimiter/separator between the columns

original_tz

The time zone with which the datetime are encoded

target_tz

The time zone with which you want to process the data. Setting this argument to 'GMT' will help you coping with daylight saving time where changes occur two time a year.

sampling

The sampling frequency in minutes (default 15 min)

trim_first_day

if True, removes the data from the first day if it contains less than 80% of the expected data points.

trim_middle_days

if True, removes the data from the MIDDLE days if they contain less than 80% of the expected data points.

trim_last_day

if True, removes the data from the last day if it contains less than 80% of the expected data points.

verbose

print out some useful information during the execution of the function

Details

This function prepare the data stored in a csv to be compatible with the digiRhythm package. You have the possibility to skip the first lines and choose which columns to read. You also have the possibility to sample the data. You can also choose whether to remove partial days (where no data over a full day is present) by trimming last, middle or last days. This function expects that the first and second columns are respectively date and time where the format should be mentioned.

file <- file.path('data', 'sample_data') colstoread <- c("Date", "Time", "Motion Index", 'Steps') #The colums that we are interested in data <- improt_raw_icetag_data(filename = file, skipLines = 7, act.cols.names = colstoread, sampling = 15, verbose = TRUE)

Value

A dataframe with datetime column and other activity columns, ready to be used with other functions in digirhythm

Examples


filename <- system.file("extdata", "sample_data.csv", package = "digiRhythm")
data <- import_raw_activity_data(
    filename,
    skipLines = 7,
    act.cols.names = c("Date", "Time", "Motion Index", 'Steps'),
    sep = ',',
    original_tz = 'CET',
    target_tz = 'CET',
    date_format = "%d.%m.%Y",
    time_format = "%H:%M:%S",
    sampling = 15,
    trim_first_day = TRUE,
    trim_middle_days = TRUE,
    trim_last_day = TRUE,
    verbose = TRUE)
print(head(data))


[Package digiRhythm version 1.1 Index]