You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 lines
1.4 KiB
42 lines
1.4 KiB
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/read_docs.r
|
|
\name{read_docx}
|
|
\alias{read_docx}
|
|
\title{Read in a Word document for table extraction}
|
|
\usage{
|
|
read_docx(path, track_changes = NULL)
|
|
}
|
|
\arguments{
|
|
\item{path}{path to the Word document}
|
|
|
|
\item{track_changes}{if not \code{NULL} (the default) then must be one of
|
|
"\code{accept}" or "\code{reject}" which will, respectively, accept all or
|
|
reject all changes. NOTE: this functionality relies on the
|
|
\code{pandoc} utility being available on the system \code{PATH}. Both
|
|
system \code{PATH} and the \code{RSTUDIO_PANDOC} (RStudio ships with
|
|
a copy of \code{pandoc}) environment variables will be checked.
|
|
If no \code{pandoc} binary is found then a warning will be issued
|
|
and the document will be read without integrating or ignoring
|
|
any tracked changes. The original Word document \emph{will not be modified}
|
|
and this feature \emph{only works} with \code{docx} files.}
|
|
}
|
|
\description{
|
|
Local file path or URL pointing to a \code{.docx} file. Can also take
|
|
\code{.doc} file as input if \code{LibreOffice} is installed
|
|
(see \url{https://www.libreoffice.org/} for more info and to download).
|
|
}
|
|
\examples{
|
|
doc <- read_docx(system.file("examples/data.docx", package="docxtractr"))
|
|
class(doc)
|
|
|
|
doc <- read_docx(
|
|
system.file("examples/trackchanges.docx", package="docxtractr"),
|
|
track_changes = "accept"
|
|
)
|
|
|
|
\dontrun{
|
|
# from a URL
|
|
budget <- read_docx(
|
|
"http://rud.is/dl/1.DOCX")
|
|
}
|
|
}
|
|
|