Created R package mtt

man/create_eventlogs.Rd

@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/create_eventlogs.R
+\name{create_eventlogs}
+\alias{create_eventlogs}
+\title{Creating log events from raw log files.}
+\usage{
+create_eventlogs(data)
+}
+\arguments{
+\item{data}{Data frame of raw log files created with \code{parse_logfiles()}.
+See \code{?parse_logfiles} for more details.}
+}
+\value{
+Data frame.
+}
+\description{
+Creating event logs from a data frame of raw log files from a
+Multi-Touch-Table at the IWM.
+}
+\examples{
+# tbd
+}

man/leftpad_fnames.Rd

@@ -0,0 +1,28 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/parse_logfiles.R
+\name{leftpad_fnames}
+\alias{leftpad_fnames}
+\title{Left padding file names of raw log files from Multi-Touch-Table at the
+IWM.}
+\usage{
+leftpad_fnames(x, dirpaths)
+}
+\arguments{
+\item{x}{file name in the form of `yyyy_mm_dd-hh_mm_ss.}
+
+\item{dirpaths}{Paths on system where files live that should be renamed.}
+}
+\value{
+Left padded file names.
+}
+\description{
+File names need to be left padded since otherwise the sorting of the
+timestamps will be off and one will get negative durations later on
+since the wrong events get closed.
+}
+\examples{
+# folders <- "all"
+# dirpaths <- paste0("../data/haum_logs_2016-2023/", folders)
+# fnames <- dir(dirpaths, pattern = "*.log", full.names = TRUE)
+# leftpad_fnames(fnames)
+}

man/parse_logfiles.Rd

@@ -0,0 +1,30 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/parse_logfiles.R
+\name{parse_logfiles}
+\alias{parse_logfiles}
+\title{Creating data frame for raw log files.}
+\usage{
+parse_logfiles(folders, path, file = "rawdata_logfiles.csv", save = TRUE)
+}
+\arguments{
+\item{folders}{A character vector of folder names that contain the raw
+log files from the Multi-Touch-Table at the IWM.}
+
+\item{path}{A path to the folders.}
+
+\item{file}{Name of the file where parsed log files should be saved.
+Default is "rawdata_logfiles.csv".}
+
+\item{save}{Logical. If data frame should be returned by the function or
+saved. Default is TRUE.}
+}
+\value{
+A data frame or NULL.
+}
+\description{
+Creates a data frame or CSV file from raw log files from a
+Multi-Touch-Table at the IWM.
+}
+\examples{
+# parse_logfiles("all", path = "../data/haum_logs_2016-2023/")
+}