Ran checks and updated

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
+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: GPL (>= 2)
-    license
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3

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)

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"?
 
     }
   )

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{<artwork>.xml}.}
-
 \item{xmlpath}{Path to folder where XML definitions of artworks live.}
 }
 \value{

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{<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
+}

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{<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
+}