Ran checks and updated
This commit is contained in:
@@ -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{
|
||||
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
Reference in New Issue
Block a user