Browse Source

fix typos and re document

pull/12/head
markdly 6 years ago
parent
commit
ff2fc32726
  1. 2
      R/assign_colnames.r
  2. 4
      R/extract_all.r
  3. 2
      R/utils.r
  4. 2
      man/assign_colnames.Rd
  5. 2
      man/docx_extract_all.Rd
  6. 2
      man/docx_extract_all_tbls.Rd

2
R/assign_colnames.r

@ -13,7 +13,7 @@
#' the column names
#' @param remove remove row specified by \code{row} after making it
#' the column names? (Default: \code{TRUE})
#' @param remove_previous remove any rows preceeding \code{row}? (Default:
#' @param remove_previous remove any rows preceding \code{row}? (Default:
#' \code{TRUE} but will be assigned whatever is given for
#' \code{remove}).
#' @return \code{data.frame}

4
R/extract_all.r

@ -1,7 +1,7 @@
#' Extract all tables from a Word document
#'
#' @param docx \code{docx} object read with \code{read_docx}
#' @param guess_header should the function make a guess as to the existense of
#' @param guess_header should the function make a guess as to the existence of
#' a header in a table? (Default: \code{TRUE})
#' @param preserve preserve line breaks within a cell? Default: `FALSE`. NOTE: This overrides `trim`.
#' @param trim trim leading/trailing whitespace (if any) in cells? (default: \code{TRUE})
@ -39,7 +39,7 @@ docx_extract_all_tbls <- function(docx, guess_header=TRUE, preserve=FALSE, trim=
#' Extract all tables from a Word document
#'
#' @param docx \code{docx} object read with \code{read_docx}
#' @param guess_header should the function make a guess as to the existense of
#' @param guess_header should the function make a guess as to the existence of
#' a header in a table? (Default: \code{TRUE})
#' @param preserve preserve line breaks within a cell? Default: `FALSE`. NOTE: This overrides `trim`.
#' @param trim trim leading/trailing whitespace (if any) in cells? (default: \code{TRUE})

2
R/utils.r

@ -1,4 +1,4 @@
# used by cuntions to make sure they are working with a well-formed docx object
# used by functions to make sure they are working with a well-formed docx object
ensure_docx <- function(docx) {
if (!inherits(docx, "docx")) stop("Must pass in a 'docx' object", call.=FALSE)
if (!(all(purrr::map_lgl(c("docx", "ns", "tbls", "path"), exists, where=docx))))

2
man/assign_colnames.Rd

@ -16,7 +16,7 @@ the column names}
\item{remove}{remove row specified by \code{row} after making it
the column names? (Default: \code{TRUE})}
\item{remove_previous}{remove any rows preceeding \code{row}? (Default:
\item{remove_previous}{remove any rows preceding \code{row}? (Default:
\code{TRUE} but will be assigned whatever is given for
\code{remove}).}
}

2
man/docx_extract_all.Rd

@ -9,7 +9,7 @@ docx_extract_all(docx, guess_header = TRUE, preserve = FALSE, trim = TRUE)
\arguments{
\item{docx}{\code{docx} object read with \code{read_docx}}
\item{guess_header}{should the function make a guess as to the existense of
\item{guess_header}{should the function make a guess as to the existence of
a header in a table? (Default: \code{TRUE})}
\item{preserve}{preserve line breaks within a cell? Default: `FALSE`. NOTE: This overrides `trim`.}

2
man/docx_extract_all_tbls.Rd

@ -10,7 +10,7 @@ docx_extract_all_tbls(docx, guess_header = TRUE, preserve = FALSE,
\arguments{
\item{docx}{\code{docx} object read with \code{read_docx}}
\item{guess_header}{should the function make a guess as to the existense of
\item{guess_header}{should the function make a guess as to the existence of
a header in a table? (Default: \code{TRUE})}
\item{preserve}{preserve line breaks within a cell? Default: `FALSE`. NOTE: This overrides `trim`.}

Loading…
Cancel
Save