% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/reporting.R
\name{gb_to_word}
\alias{gb_to_word}
\title{Export an appraisal to Word}
\usage{
gb_to_word(appraisal, file)
}
\arguments{
\item{appraisal}{A \code{gb_appraisal} object.}

\item{file}{Output file path (must end in \code{.docx}).}
}
\value{
Invisibly, the file path.
}
\description{
Writes a one-page Word document with the appraisal headline and
cashflow table.
}
\details{
Requires the \code{officer} and \code{flextable} packages (both in Suggests).
}
\examples{
\donttest{
if (requireNamespace("officer", quietly = TRUE) &&
    requireNamespace("flextable", quietly = TRUE)) {
  app <- gb_appraise(c(100, 0, 0, 0, 0), c(0, 30, 30, 30, 30))
  tmp <- tempfile(fileext = ".docx")
  gb_to_word(app, tmp)
}
}
}
\seealso{
\code{\link[=gb_to_latex]{gb_to_latex()}}, \code{\link[=gb_to_excel]{gb_to_excel()}}.

Other reporting: 
\code{\link{gb_cost_per_unit}()},
\code{\link{gb_headline}()},
\code{\link{gb_to_excel}()},
\code{\link{gb_to_latex}()}
}
\concept{reporting}
