diff --git a/DESCRIPTION b/DESCRIPTION index 762c8c4..7f9f7f1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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 diff --git a/NAMESPACE b/NAMESPACE index 158dff3..28ec026 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,4 +1,6 @@ # Generated by roxygen2: do not edit by hand export(create_eventlogs) +export(extract_artworks) +export(extract_topics) export(parse_logfiles) diff --git a/R/close_events.R b/R/close_events.R index 87929dc..b60334e 100644 --- a/R/close_events.R +++ b/R/close_events.R @@ -33,7 +33,7 @@ close_events <- function(data, event = c("move", "flipCard", "openTopic", "openP "artwork", "popup") drop <- c("topicNumber", "event") ncol <- 19 -# TODO: Should topicNumber maybe also be filled in for "openPopup"? +# TODO: Should topicNumber maybe also be filled in for "openPopup"? } ) diff --git a/man/create_eventlogs.Rd b/man/create_eventlogs.Rd index de35622..7bd1f55 100644 --- a/man/create_eventlogs.Rd +++ b/man/create_eventlogs.Rd @@ -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{.xml}.} - \item{xmlpath}{Path to folder where XML definitions of artworks live.} } \value{ diff --git a/man/extract_artworks.Rd b/man/extract_artworks.Rd new file mode 100644 index 0000000..9b526f9 --- /dev/null +++ b/man/extract_artworks.Rd @@ -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{.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 +} diff --git a/man/extract_topics.Rd b/man/extract_topics.Rd new file mode 100644 index 0000000..631307f --- /dev/null +++ b/man/extract_topics.Rd @@ -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{.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 +}