R/mtt
R/mtt
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ran checks and updated

Browse Source
This commit is contained in:
Nora Wickelmaier 2023-09-28 16:04:38 +02:00
parent 0e911bed3f
commit b07e0923dc
6 changed files with 61 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
DESCRIPTION
View File

@ -1,12 +1,11 @@
Package: mtt
Title: Log files from a Multi-Touch-Table
Version: 0.0.0.9000
Version: 0.0-1
Authors@R:
person("Nora", "Wickelmaier", , "n.wickelmaier@iwm-tuebingen.de", role = c("aut", "cre"))
Imports: stats, utils, dplyr, pbapply, XML, lubridate
Description: Creating event logs from raw log files from a Multi-Touch-Table at the IWM
License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a
license
Description: Creating event logs from raw log files from a Multi-Touch-Table at the IWM.
License: GPL (>= 2)
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3

2
NAMESPACE
View File

@ -1,4 +1,6 @@
# Generated by roxygen2: do not edit by hand
export(create_eventlogs)
export(extract_artworks)
export(extract_topics)
export(parse_logfiles)

5
man/create_eventlogs.Rd
View File

@ -4,15 +4,12 @@
\alias{create_eventlogs}
\title{Creating log events from raw log files.}
\usage{
create_eventlogs(data, xmlfiles, xmlpath)
create_eventlogs(data, xmlpath)
}
\arguments{
\item{data}{Data frame of raw log files created with \code{parse_logfiles()}.
See \code{?parse_logfiles} for more details.}
\item{xmlfiles}{Vector of names of index files, often something like
\verb{<artwork>.xml}.}
\item{xmlpath}{Path to folder where XML definitions of artworks live.}
}
\value{

27
man/extract_artworks.Rd Normal file
View File

@ -0,0 +1,27 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/extract_artworks.R
\name{extract_artworks}
\alias{extract_artworks}
\title{Creating data frame with information about artworks}
\usage{
extract_artworks(artworks, xmlfiles, xmlpath)
}
\arguments{
\item{artworks}{A character vector with names of the artworks. Needs to
correspond to the folder names which contain the XML files.}
\item{xmlfiles}{Vector of names of index files, often something like
\verb{<artwork>.xml}. Need to be in the same order as artworks!}
\item{xmlpath}{Path to folder where XML definitions of artworks live.}
}
\value{
Data frame.
}
\description{
Information about artowrks are extracted from XML files and written to a
data frame that contains \code{artist}, \code{title}, \code{misc}, and \code{description}.
}
\examples{
# tbd
}

27
man/extract_topics.Rd Normal file
View File

@ -0,0 +1,27 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/extract_topics.R
\name{extract_topics}
\alias{extract_topics}
\title{Creating data frame with artworks and topics}
\usage{
extract_topics(artworks, xmlfiles, xmlpath)
}
\arguments{
\item{artworks}{A character vector with names of the artworks. Needs to
correspond to the folder names which contain the XML files.}
\item{xmlfiles}{Vector of names of index files, often something like
\verb{<artwork>.xml}. Need to be in the same order as artworks!}
\item{xmlpath}{Path to folder where XML definitions of artworks live.}
}
\value{
Data frame.
}
\description{
Topics are extracted from XML files and written to a data frame that
shows which artworks belong to which topics.
}
\examples{
# tbd
}