From 6de0c8bc285e43e31acae1a75d284f1cc03ba293 Mon Sep 17 00:00:00 2001 From: Jan Marvin Garbuszus Date: Mon, 10 Jul 2023 22:03:06 +0200 Subject: [PATCH] make functions and classes internal --- NAMESPACE | 10 - NEWS.md | 4 + R/class-comment.R | 3 +- R/class-hyperlink.R | 3 +- R/class-sheet-data.R | 5 +- R/class-style_mgr.R | 4 +- R/class-worksheet.R | 3 +- R/converters.R | 3 +- R/dates.R | 3 +- R/pugixml.R | 3 +- R/wb_functions.R | 3 +- man/get_cell_refs.Rd | 23 -- man/get_date_origin.Rd | 40 --- man/guess_col_type.Rd | 16 -- man/style_mgr.Rd | 637 ----------------------------------------- man/wbComment.Rd | 99 ------- man/wbHyperlink.Rd | 123 -------- man/wbSheetData.Rd | 67 ----- man/wbWorksheet.Rd | 555 ----------------------------------- man/write_file.Rd | 23 -- 20 files changed, 23 insertions(+), 1604 deletions(-) delete mode 100644 man/get_cell_refs.Rd delete mode 100644 man/get_date_origin.Rd delete mode 100644 man/guess_col_type.Rd delete mode 100644 man/style_mgr.Rd delete mode 100644 man/wbComment.Rd delete mode 100644 man/wbHyperlink.Rd delete mode 100644 man/wbSheetData.Rd delete mode 100644 man/wbWorksheet.Rd delete mode 100644 man/write_file.Rd diff --git a/NAMESPACE b/NAMESPACE index 436df3453..7b0eda434 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -30,9 +30,6 @@ export(delete_data) export(dims_to_dataframe) export(dims_to_rowcol) export(fmt_txt) -export(get_cell_refs) -export(get_date_origin) -export(guess_col_type) export(int2col) export(na_strings) export(next_sheet) @@ -41,15 +38,10 @@ export(read_xlsx) export(read_xml) export(remove_comment) export(rowcol_to_dims) -export(style_mgr) export(styles_on_sheet) export(temp_xlsx) export(wbChartSheet) -export(wbComment) -export(wbHyperlink) -export(wbSheetData) export(wbWorkbook) -export(wbWorksheet) export(wb_add_border) export(wb_add_cell_style) export(wb_add_chart_xml) @@ -130,7 +122,6 @@ export(wb_set_selected) export(wb_set_sheet_names) export(wb_set_sheet_visibility) export(wb_set_sheetview) -export(wb_sheet_data) export(wb_to_df) export(wb_ungroup_cols) export(wb_ungroup_rows) @@ -141,7 +132,6 @@ export(wb_ws) export(write_comment) export(write_data) export(write_datatable) -export(write_file) export(write_formula) export(write_xlsx) export(xl_open) diff --git a/NEWS.md b/NEWS.md index 92b9ce925..3dabf968b 100644 --- a/NEWS.md +++ b/NEWS.md @@ -7,6 +7,7 @@ ## Breaking changes * Order of arguments in `wb_add_named_region()` changed, because previously overlooked `dims` argument was added. +* In various functions the order of `dims` was changed, to highlight it's importance * Cleanups * remove deprecated functions @@ -18,6 +19,9 @@ * deprecating function * `convertToExcelDate()` for `convert_to_excel_date()` + * make `get_cell_refs()`, `get_date_origin()`, `guess_col_type()`, and `write_file()` internal functions + * make classes `styles_mgr()`, `wbSheetData`, `wbWorksheet`, `wbChartsheet`, `wbComment`, `wbHyperlink` internal + *************************************************************************** diff --git a/R/class-comment.R b/R/class-comment.R index 3440583f3..08313b586 100644 --- a/R/class-comment.R +++ b/R/class-comment.R @@ -2,7 +2,8 @@ #' #' A comment #' -#' @export +#' @keywords internal +#' @noRd wbComment <- R6::R6Class( "wbComment", diff --git a/R/class-hyperlink.R b/R/class-hyperlink.R index f04784d5d..74f533a4f 100644 --- a/R/class-hyperlink.R +++ b/R/class-hyperlink.R @@ -2,7 +2,8 @@ #' #' A hyperlink #' -#' @export +#' @keywords internal +#' @noRd wbHyperlink <- R6::R6Class( "wbHyperlink", diff --git a/R/class-sheet-data.R b/R/class-sheet-data.R index 341b37dff..44b561cbf 100644 --- a/R/class-sheet-data.R +++ b/R/class-sheet-data.R @@ -3,7 +3,8 @@ #' #' A hyperlink #' -#' @export +#' @keywords internal +#' @noRd wbSheetData <- R6::R6Class( "wbSheetData", public = list( @@ -30,7 +31,7 @@ wbSheetData <- R6::R6Class( ## TODO is this even used? #' @rdname wbSheetData #' @keywords internal -#' @export +#' @noRd wb_sheet_data <- function() { wbSheetData$new() } diff --git a/R/class-style_mgr.R b/R/class-style_mgr.R index 3c4a2618a..b03b781f4 100644 --- a/R/class-style_mgr.R +++ b/R/class-style_mgr.R @@ -65,7 +65,8 @@ #' wb$set_cell_style("SUM", "C7:C16", wb$styles_mgr$get_xf_id("new_xf")) #' # wb_open(wb) #' -#' @export +#' @keywords internal +#' @noRd style_mgr <- R6::R6Class("wbStylesMgr", { public <- list( @@ -603,7 +604,6 @@ style_mgr <- R6::R6Class("wbStylesMgr", { #' "Title" #' "Total" #' "Warning Text" - #' @export init_named_style = function(name, font_name = "Arial", font_size = 11) { # we probably should only have unique named styles. check if style is found. diff --git a/R/class-worksheet.R b/R/class-worksheet.R index 35b576b13..ffd29150f 100644 --- a/R/class-worksheet.R +++ b/R/class-worksheet.R @@ -5,7 +5,8 @@ #' #' A Worksheet #' -#' @export +#' @keywords internal +#' @noRd wbWorksheet <- R6::R6Class( "wbWorksheet", diff --git a/R/converters.R b/R/converters.R index fb746757d..0ca7e2acc 100644 --- a/R/converters.R +++ b/R/converters.R @@ -59,7 +59,8 @@ col2int <- function(x) { #' # "B1" #' get_cell_refs(data.frame(1:3, 2:4)) #' # "B1" "C2" "D3" -#' @export +#' @keywords internal +#' @noRd get_cell_refs <- function(cellCoords) { assert_class(cellCoords, "data.frame") stopifnot(ncol(cellCoords) == 2L) diff --git a/R/dates.R b/R/dates.R index 84f77c7f3..36126b5e8 100644 --- a/R/dates.R +++ b/R/dates.R @@ -106,7 +106,8 @@ convert_hms <- function(x) { #' #' get_date_origin(wb_workbook()) #' get_date_origin(wb_workbook(), origin = TRUE) -#' @export +#' @keywords internal +#' @noRd get_date_origin <- function(xlsxFile, origin = FALSE) { # TODO: allow using a workbook? diff --git a/R/pugixml.R b/R/pugixml.R index 560b01f15..6df63a053 100644 --- a/R/pugixml.R +++ b/R/pugixml.R @@ -265,7 +265,8 @@ as_xml <- function(x, ...) { #' @param fl file name with full path #' @param escapes bool if characters like "&" should be escaped. The default is #' no escape, assuming that xml to export is already valid. -#' @export +#' @keywords internal +#' @noRd # TODO needs a unit test write_file <- function(head = "", body = "", tail = "", fl = "", escapes = FALSE) { if (getOption("openxlsx2.force_utf8_encoding", default = FALSE)) { diff --git a/R/wb_functions.R b/R/wb_functions.R index 6f0c06081..4099fc96a 100644 --- a/R/wb_functions.R +++ b/R/wb_functions.R @@ -83,7 +83,8 @@ dataframe_to_dims <- function(df) { #' function to estimate the column type. #' 0 = character, 1 = numeric, 2 = date. #' @param tt dataframe produced by wb_to_df() -#' @export +#' @keywords internal +#' @noRd guess_col_type <- function(tt) { # all columns are character diff --git a/man/get_cell_refs.Rd b/man/get_cell_refs.Rd deleted file mode 100644 index 39784f8f7..000000000 --- a/man/get_cell_refs.Rd +++ /dev/null @@ -1,23 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/converters.R -\name{get_cell_refs} -\alias{get_cell_refs} -\title{Return excel cell coordinates from (x,y) coordinates} -\usage{ -get_cell_refs(cellCoords) -} -\arguments{ -\item{cellCoords}{A data.frame with two columns coordinate pairs.} -} -\value{ -Excel alphanumeric cell reference -} -\description{ -Return excel cell coordinates from (x,y) coordinates -} -\examples{ -get_cell_refs(data.frame(1, 2)) -# "B1" -get_cell_refs(data.frame(1:3, 2:4)) -# "B1" "C2" "D3" -} diff --git a/man/get_date_origin.Rd b/man/get_date_origin.Rd deleted file mode 100644 index b840857f8..000000000 --- a/man/get_date_origin.Rd +++ /dev/null @@ -1,40 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dates.R -\name{get_date_origin} -\alias{get_date_origin} -\title{Get the date origin an xlsx file is using} -\usage{ -get_date_origin(xlsxFile, origin = FALSE) -} -\arguments{ -\item{xlsxFile}{An xlsx or xlsm file or a wbWorkbook object.} - -\item{origin}{return the origin instead of the character string.} -} -\value{ -One of "1900-01-01" or "1904-01-01". -} -\description{ -Return the date origin used internally by an xlsx or xlsm file -} -\details{ -Excel stores dates as the number of days from either 1904-01-01 or 1900-01-01. This function -checks the date origin being used in an Excel file and returns is so it can be used in \code{\link[=convert_date]{convert_date()}} -} -\examples{ - -## create a file with some dates -temp <- temp_xlsx() -write_xlsx(as.Date("2015-01-10") - (0:4), file = temp) -m <- read_xlsx(temp) - -## convert to dates -do <- get_date_origin(system.file("extdata", "openxlsx2_example.xlsx", package = "openxlsx2")) -convert_date(m[[1]], do) - -get_date_origin(wb_workbook()) -get_date_origin(wb_workbook(), origin = TRUE) -} -\seealso{ -\code{\link[=convert_date]{convert_date()}} -} diff --git a/man/guess_col_type.Rd b/man/guess_col_type.Rd deleted file mode 100644 index 5e56c2d25..000000000 --- a/man/guess_col_type.Rd +++ /dev/null @@ -1,16 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/wb_functions.R -\name{guess_col_type} -\alias{guess_col_type} -\title{function to estimate the column type. -0 = character, 1 = numeric, 2 = date.} -\usage{ -guess_col_type(tt) -} -\arguments{ -\item{tt}{dataframe produced by wb_to_df()} -} -\description{ -function to estimate the column type. -0 = character, 1 = numeric, 2 = date. -} diff --git a/man/style_mgr.Rd b/man/style_mgr.Rd deleted file mode 100644 index 796345f62..000000000 --- a/man/style_mgr.Rd +++ /dev/null @@ -1,637 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/class-style_mgr.R -\name{style_mgr} -\alias{style_mgr} -\title{style manager} -\description{ -style manager - -style manager -} -\examples{ -xlsxFile <- system.file("extdata", "oxlsx2_sheet.xlsx", package = "openxlsx2") -wb <- wb_load(xlsxFile) - -# ## start style mgr -# style <- style_mgr$new(wb) -# style$initialize(wb) - -# wb$styles_mgr$get_numfmt() |> print() -# wb$styles_mgr$next_numfmt_id() |> print() -# wb$styles_mgr$get_numfmt_id("numFmt-166") - -# create new number format -new_numfmt <- create_numfmt(numFmtId = wb$styles_mgr$next_numfmt_id(), formatCode = "#,#") - -# add it via stylemgr -wb$styles_mgr$add(new_numfmt, "test") - -## get numfmts (invisible) -# z <- wb$styles_mgr$get_numfmt() -# z -wb$styles_mgr$styles$numFmts - -## create and add huge font -new_huge_font <- create_font(sz = "20", name = "Arial", b = "1", - color = wb_color(hex = "FFFFFFFF")) -wb$styles_mgr$add(new_huge_font, "arial_huge") - -## create another font -new_font <- create_font(name = "Arial") -wb$styles_mgr$add(new_font, "arial") - -## create and add new fill -new_fill <- create_fill(patternType = "solid", fgColor = wb_color(hex = "FF00224B")) -wb$styles_mgr$add(new_fill, "blue") - -# create new style with numfmt enabled -head_xf <- create_cell_style( - horizontal = "center", - textRotation = "45", - numFmtId = "0", - fontId = wb$styles_mgr$get_font_id("arial_huge"), - fillId = wb$styles_mgr$get_fill_id("blue") -) - -new_xf <- create_cell_style( - numFmtId = wb$styles_mgr$get_numfmt_id("test"), - fontId = wb$styles_mgr$get_font_id("arial") -) - -## add new styles -wb$styles_mgr$add(head_xf, "head_xf") -wb$styles_mgr$add(new_xf, "new_xf") - -## get cell style ids (invisible) -# z <- wb$styles_mgr$get_xf() - -## get cell style id -# wb$styles_mgr$get_xf_id("new_xf") - - ## assign styles to cells -wb$set_cell_style("SUM", "B3:I3", wb$styles_mgr$get_xf_id("head_xf")) -wb$set_cell_style("SUM", "C7:C16", wb$styles_mgr$get_xf_id("new_xf")) -# wb_open(wb) - -} -\section{Public fields}{ -\if{html}{\out{
}} -\describe{ -\item{\code{numfmt}}{numfmt-ids} - -\item{\code{font}}{font-ids} - -\item{\code{fill}}{fill-ids} - -\item{\code{border}}{border-ids} - -\item{\code{xf}}{xf-ids} - -\item{\code{cellStyle}}{cellStyle-ids} - -\item{\code{cellStyleXf}}{cellStyleXf-ids} - -\item{\code{dxf}}{dxf-ids} - -\item{\code{tableStyle}}{tableStyle-ids} - -\item{\code{defaultTableStyle}}{defaultTableStyle} - -\item{\code{defaultPivotStyle}}{defaultPivotStyle} - -\item{\code{styles}}{styles as xml} -} -\if{html}{\out{
}} -} -\section{Methods}{ -\subsection{Public methods}{ -\itemize{ -\item \href{#method-wbStylesMgr-new}{\code{style_mgr$new()}} -\item \href{#method-wbStylesMgr-get_numfmt}{\code{style_mgr$get_numfmt()}} -\item \href{#method-wbStylesMgr-get_font}{\code{style_mgr$get_font()}} -\item \href{#method-wbStylesMgr-get_fill}{\code{style_mgr$get_fill()}} -\item \href{#method-wbStylesMgr-get_border}{\code{style_mgr$get_border()}} -\item \href{#method-wbStylesMgr-get_xf}{\code{style_mgr$get_xf()}} -\item \href{#method-wbStylesMgr-get_cellStyle}{\code{style_mgr$get_cellStyle()}} -\item \href{#method-wbStylesMgr-get_cellStyleXf}{\code{style_mgr$get_cellStyleXf()}} -\item \href{#method-wbStylesMgr-get_dxf}{\code{style_mgr$get_dxf()}} -\item \href{#method-wbStylesMgr-get_numfmt_id}{\code{style_mgr$get_numfmt_id()}} -\item \href{#method-wbStylesMgr-get_font_id}{\code{style_mgr$get_font_id()}} -\item \href{#method-wbStylesMgr-get_fill_id}{\code{style_mgr$get_fill_id()}} -\item \href{#method-wbStylesMgr-get_border_id}{\code{style_mgr$get_border_id()}} -\item \href{#method-wbStylesMgr-get_xf_id}{\code{style_mgr$get_xf_id()}} -\item \href{#method-wbStylesMgr-get_cellStyle_id}{\code{style_mgr$get_cellStyle_id()}} -\item \href{#method-wbStylesMgr-get_cellStyleXf_id}{\code{style_mgr$get_cellStyleXf_id()}} -\item \href{#method-wbStylesMgr-get_dxf_id}{\code{style_mgr$get_dxf_id()}} -\item \href{#method-wbStylesMgr-get_tableStyle_id}{\code{style_mgr$get_tableStyle_id()}} -\item \href{#method-wbStylesMgr-next_numfmt_id}{\code{style_mgr$next_numfmt_id()}} -\item \href{#method-wbStylesMgr-next_font_id}{\code{style_mgr$next_font_id()}} -\item \href{#method-wbStylesMgr-next_fill_id}{\code{style_mgr$next_fill_id()}} -\item \href{#method-wbStylesMgr-next_border_id}{\code{style_mgr$next_border_id()}} -\item \href{#method-wbStylesMgr-next_xf_id}{\code{style_mgr$next_xf_id()}} -\item \href{#method-wbStylesMgr-next_cellstyle_id}{\code{style_mgr$next_cellstyle_id()}} -\item \href{#method-wbStylesMgr-next_cellstylexf_id}{\code{style_mgr$next_cellstylexf_id()}} -\item \href{#method-wbStylesMgr-next_dxf_id}{\code{style_mgr$next_dxf_id()}} -\item \href{#method-wbStylesMgr-next_tableStyle_id}{\code{style_mgr$next_tableStyle_id()}} -\item \href{#method-wbStylesMgr-getstyle_ids}{\code{style_mgr$getstyle_ids()}} -\item \href{#method-wbStylesMgr-add}{\code{style_mgr$add()}} -\item \href{#method-wbStylesMgr-init_named_style}{\code{style_mgr$init_named_style()}} -\item \href{#method-wbStylesMgr-clone}{\code{style_mgr$clone()}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-new}{}}} -\subsection{Method \code{new()}}{ -Creates a new \code{wbStylesMgr} object -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$new( - numfmt = NA, - font = NA, - fill = NA, - border = NA, - xf = NA, - cellStyle = NA, - cellStyleXf = NA, - dxf = NA, - styles = NA -)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{numfmt}}{numfmt} - -\item{\code{font}}{font} - -\item{\code{fill}}{fill} - -\item{\code{border}}{border} - -\item{\code{xf}}{xf} - -\item{\code{cellStyle}}{cellStyles} - -\item{\code{cellStyleXf}}{cellStylesXf} - -\item{\code{dxf}}{dxf} - -\item{\code{styles}}{styles} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -a \code{wbStylesMgr} object -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_numfmt}{}}} -\subsection{Method \code{get_numfmt()}}{ -get numfmt ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_numfmt()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_font}{}}} -\subsection{Method \code{get_font()}}{ -get font ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_font()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_fill}{}}} -\subsection{Method \code{get_fill()}}{ -get fill ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_fill()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_border}{}}} -\subsection{Method \code{get_border()}}{ -get border ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_border()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_xf}{}}} -\subsection{Method \code{get_xf()}}{ -get xf ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_xf()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_cellStyle}{}}} -\subsection{Method \code{get_cellStyle()}}{ -get cellstyle ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_cellStyle()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_cellStyleXf}{}}} -\subsection{Method \code{get_cellStyleXf()}}{ -get cellstylexf ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_cellStyleXf()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_dxf}{}}} -\subsection{Method \code{get_dxf()}}{ -get dxf ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_dxf()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_numfmt_id}{}}} -\subsection{Method \code{get_numfmt_id()}}{ -get numfmt id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_numfmt_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_font_id}{}}} -\subsection{Method \code{get_font_id()}}{ -get font id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_font_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_fill_id}{}}} -\subsection{Method \code{get_fill_id()}}{ -get fill id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_fill_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_border_id}{}}} -\subsection{Method \code{get_border_id()}}{ -get border id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_border_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_xf_id}{}}} -\subsection{Method \code{get_xf_id()}}{ -get xf id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_xf_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_cellStyle_id}{}}} -\subsection{Method \code{get_cellStyle_id()}}{ -get cellstyle id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_cellStyle_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_cellStyleXf_id}{}}} -\subsection{Method \code{get_cellStyleXf_id()}}{ -get cellstyleXf id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_cellStyleXf_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_dxf_id}{}}} -\subsection{Method \code{get_dxf_id()}}{ -get dxf id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_dxf_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-get_tableStyle_id}{}}} -\subsection{Method \code{get_tableStyle_id()}}{ -get tableStyle id by name -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$get_tableStyle_id(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_numfmt_id}{}}} -\subsection{Method \code{next_numfmt_id()}}{ -get next numfmt id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_numfmt_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_font_id}{}}} -\subsection{Method \code{next_font_id()}}{ -get next font id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_font_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_fill_id}{}}} -\subsection{Method \code{next_fill_id()}}{ -get next fill id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_fill_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_border_id}{}}} -\subsection{Method \code{next_border_id()}}{ -get next border id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_border_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_xf_id}{}}} -\subsection{Method \code{next_xf_id()}}{ -get next xf id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_xf_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_cellstyle_id}{}}} -\subsection{Method \code{next_cellstyle_id()}}{ -get next xf id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_cellstyle_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_cellstylexf_id}{}}} -\subsection{Method \code{next_cellstylexf_id()}}{ -get next xf id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_cellstylexf_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_dxf_id}{}}} -\subsection{Method \code{next_dxf_id()}}{ -get next dxf id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_dxf_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-next_tableStyle_id}{}}} -\subsection{Method \code{next_tableStyle_id()}}{ -get next tableStyle id -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$next_tableStyle_id()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-getstyle_ids}{}}} -\subsection{Method \code{getstyle_ids()}}{ -get named style ids -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$getstyle_ids(name)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{name} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-add}{}}} -\subsection{Method \code{add()}}{ -add entry -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$add(style, style_name, skip_duplicates = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{style}}{new_style} - -\item{\code{style_name}}{a unique name identifying the style} - -\item{\code{skip_duplicates}}{should duplicates be added?} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-init_named_style}{}}} -\subsection{Method \code{init_named_style()}}{ -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$init_named_style(name, font_name = "Arial", font_size = 11)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{name}}{style name} - -\item{\code{font_name, font_size}}{optional else the default of the theme} - -\item{\code{wb}}{wbWorkbook} -} -\if{html}{\out{
}} -} -\subsection{Details}{ -possible styles are: -"20\% - Accent1" -"20\% - Accent2" -"20\% - Accent3" -"20\% - Accent4" -"20\% - Accent5" -"20\% - Accent6" -"40\% - Accent1" -"40\% - Accent2" -"40\% - Accent3" -"40\% - Accent4" -"40\% - Accent5" -"40\% - Accent6" -"60\% - Accent1" -"60\% - Accent2" -"60\% - Accent3" -"60\% - Accent4" -"60\% - Accent5" -"60\% - Accent6" -"Accent1" -"Accent2" -"Accent3" -"Accent4" -"Accent5" -"Accent6" -"Bad" -"Calculation" -"Check Cell" -"Comma" -"Comma [0]" -"Currency" -"Currency [0]" -"Explanatory Text" -"Good" -"Heading 1" -"Heading 2" -"Heading 3" -"Heading 4" -"Input" -"Linked Cell" -”Neutral" -"Normal" -"Note" -"Output" -"Per cent" -"Title" -"Total" -"Warning Text" -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbStylesMgr-clone}{}}} -\subsection{Method \code{clone()}}{ -The objects of this class are cloneable with this method. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{style_mgr$clone(deep = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{deep}}{Whether to make a deep clone.} -} -\if{html}{\out{
}} -} -} -} diff --git a/man/wbComment.Rd b/man/wbComment.Rd deleted file mode 100644 index 04ccf8cc9..000000000 --- a/man/wbComment.Rd +++ /dev/null @@ -1,99 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/class-comment.R -\name{wbComment} -\alias{wbComment} -\title{R6 class for a Workbook Comments} -\value{ -The \code{wbComment} object, invisibly; called for its side effects -} -\description{ -R6 class for a Workbook Comments - -R6 class for a Workbook Comments -} -\details{ -A comment -} -\section{Public fields}{ -\if{html}{\out{
}} -\describe{ -\item{\code{text}}{Comment text} - -\item{\code{author}}{The comment author} - -\item{\code{style}}{A style for the comment} - -\item{\code{visible}}{\code{logical}, if \code{FALSE} is not visible} - -\item{\code{width}}{Width of the comment in ... units} - -\item{\code{height}}{Height of comment in ... units} -} -\if{html}{\out{
}} -} -\section{Methods}{ -\subsection{Public methods}{ -\itemize{ -\item \href{#method-wbComment-new}{\code{wbComment$new()}} -\item \href{#method-wbComment-print}{\code{wbComment$print()}} -\item \href{#method-wbComment-clone}{\code{wbComment$clone()}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbComment-new}{}}} -\subsection{Method \code{new()}}{ -Creates a new \code{wbComment} object -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbComment$new(text, author, style, visible = TRUE, width = 2, height = 4)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{text}}{Comment text} - -\item{\code{author}}{The comment author} - -\item{\code{style}}{A style for the comment} - -\item{\code{visible}}{\code{logical}, if \code{FALSE} is not visible} - -\item{\code{width}}{Width of the comment in ... units} - -\item{\code{height}}{Height of comment in ... units} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -a \code{wbComment} object -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbComment-print}{}}} -\subsection{Method \code{print()}}{ -Prints the object -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbComment$print()}\if{html}{\out{
}} -} - -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbComment-clone}{}}} -\subsection{Method \code{clone()}}{ -The objects of this class are cloneable with this method. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbComment$clone(deep = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{deep}}{Whether to make a deep clone.} -} -\if{html}{\out{
}} -} -} -} diff --git a/man/wbHyperlink.Rd b/man/wbHyperlink.Rd deleted file mode 100644 index 523f4a4ed..000000000 --- a/man/wbHyperlink.Rd +++ /dev/null @@ -1,123 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/class-hyperlink.R -\name{wbHyperlink} -\alias{wbHyperlink} -\title{R6 class for a Workbook Hyperlink} -\value{ -A character vector of html if \code{is_external} is \code{TRUE}, otherwise \code{NULL} -} -\description{ -R6 class for a Workbook Hyperlink - -R6 class for a Workbook Hyperlink -} -\details{ -A hyperlink -} -\section{Public fields}{ -\if{html}{\out{
}} -\describe{ -\item{\code{ref}}{ref} - -\item{\code{target}}{target} - -\item{\code{location}}{location} - -\item{\code{display}}{display} - -\item{\code{is_external}}{is_external} -} -\if{html}{\out{
}} -} -\section{Methods}{ -\subsection{Public methods}{ -\itemize{ -\item \href{#method-wbHyperlink-new}{\code{wbHyperlink$new()}} -\item \href{#method-wbHyperlink-to_xml}{\code{wbHyperlink$to_xml()}} -\item \href{#method-wbHyperlink-to_target_xml}{\code{wbHyperlink$to_target_xml()}} -\item \href{#method-wbHyperlink-clone}{\code{wbHyperlink$clone()}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbHyperlink-new}{}}} -\subsection{Method \code{new()}}{ -Creates a new \code{wbHyperlink} object -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbHyperlink$new(ref, target, location, display = NULL, is_external = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{ref}}{ref} - -\item{\code{target}}{target} - -\item{\code{location}}{location} - -\item{\code{display}}{display} - -\item{\code{is_external}}{is_external} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -a \code{wbHyperlink} object -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbHyperlink-to_xml}{}}} -\subsection{Method \code{to_xml()}}{ -Convert to xml -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbHyperlink$to_xml(id)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{id}}{???} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A character vector of xml -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbHyperlink-to_target_xml}{}}} -\subsection{Method \code{to_target_xml()}}{ -Convert to target xml -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbHyperlink$to_target_xml(id)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{id}}{???} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbHyperlink-clone}{}}} -\subsection{Method \code{clone()}}{ -The objects of this class are cloneable with this method. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbHyperlink$clone(deep = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{deep}}{Whether to make a deep clone.} -} -\if{html}{\out{
}} -} -} -} diff --git a/man/wbSheetData.Rd b/man/wbSheetData.Rd deleted file mode 100644 index 4c7ff2c16..000000000 --- a/man/wbSheetData.Rd +++ /dev/null @@ -1,67 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/class-sheet-data.R -\name{wbSheetData} -\alias{wbSheetData} -\alias{wb_sheet_data} -\title{R6 class for a Workbook Hyperlink} -\usage{ -wb_sheet_data() -} -\description{ -R6 class for a Workbook Hyperlink - -R6 class for a Workbook Hyperlink -} -\details{ -A hyperlink -} -\keyword{internal} -\section{Public fields}{ -\if{html}{\out{
}} -\describe{ -\item{\code{row_attr}}{row_attr} - -\item{\code{cc}}{cc} - -\item{\code{cc_out}}{cc_out} -} -\if{html}{\out{
}} -} -\section{Methods}{ -\subsection{Public methods}{ -\itemize{ -\item \href{#method-wbSheetData-new}{\code{wbSheetData$new()}} -\item \href{#method-wbSheetData-clone}{\code{wbSheetData$clone()}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbSheetData-new}{}}} -\subsection{Method \code{new()}}{ -Creates a new \code{wbSheetData} object -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbSheetData$new()}\if{html}{\out{
}} -} - -\subsection{Returns}{ -a \code{wbSheetData} object -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbSheetData-clone}{}}} -\subsection{Method \code{clone()}}{ -The objects of this class are cloneable with this method. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbSheetData$clone(deep = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{deep}}{Whether to make a deep clone.} -} -\if{html}{\out{
}} -} -} -} diff --git a/man/wbWorksheet.Rd b/man/wbWorksheet.Rd deleted file mode 100644 index 6b896b012..000000000 --- a/man/wbWorksheet.Rd +++ /dev/null @@ -1,555 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/class-worksheet.R -\name{wbWorksheet} -\alias{wbWorksheet} -\title{R6 class for a Workbook Worksheet} -\value{ -The \code{wbWorksheet} object - -The \code{wbWorksheet} object -} -\description{ -R6 class for a Workbook Worksheet - -R6 class for a Workbook Worksheet -} -\details{ -A Worksheet -} -\section{Public fields}{ -\if{html}{\out{
}} -\describe{ -\item{\code{sheetPr}}{sheetPr} - -\item{\code{dimension}}{dimension} - -\item{\code{sheetViews}}{sheetViews} - -\item{\code{sheetFormatPr}}{sheetFormatPr} - -\item{\code{sheet_data}}{sheet_data} - -\item{\code{cols_attr}}{cols_attr} - -\item{\code{autoFilter}}{autoFilter} - -\item{\code{mergeCells}}{mergeCells} - -\item{\code{conditionalFormatting}}{conditionalFormatting} - -\item{\code{dataValidations}}{dataValidations} - -\item{\code{freezePane}}{freezePane} - -\item{\code{hyperlinks}}{hyperlinks} - -\item{\code{sheetProtection}}{sheetProtection} - -\item{\code{pageMargins}}{pageMargins} - -\item{\code{pageSetup}}{pageSetup} - -\item{\code{headerFooter}}{headerFooter} - -\item{\code{rowBreaks}}{rowBreaks} - -\item{\code{colBreaks}}{colBreaks} - -\item{\code{drawing}}{drawing} - -\item{\code{legacyDrawing}}{legacyDrawing} - -\item{\code{legacyDrawingHF}}{legacyDrawingHF} - -\item{\code{oleObjects}}{oleObjects} - -\item{\code{tableParts}}{tableParts} - -\item{\code{extLst}}{extLst} - -\item{\code{cellWatches}}{cellWatches} - -\item{\code{controls}}{controls} - -\item{\code{customProperties}}{customProperties} - -\item{\code{customSheetViews}}{customSheetViews} - -\item{\code{dataConsolidate}}{dataConsolidate} - -\item{\code{drawingHF}}{drawingHF} - -\item{\code{relships}}{relships} - -\item{\code{ignoredErrors}}{ignoredErrors} - -\item{\code{phoneticPr}}{phoneticPr} - -\item{\code{picture}}{picture} - -\item{\code{printOptions}}{printOptions} - -\item{\code{protectedRanges}}{protectedRanges} - -\item{\code{scenarios}}{scenarios} - -\item{\code{sheetCalcPr}}{sheetCalcPr} - -\item{\code{smartTags}}{smartTags} - -\item{\code{sortState}}{sortState} - -\item{\code{webPublishItems}}{webPublishItems} -} -\if{html}{\out{
}} -} -\section{Methods}{ -\subsection{Public methods}{ -\itemize{ -\item \href{#method-wbWorksheet-new}{\code{wbWorksheet$new()}} -\item \href{#method-wbWorksheet-get_prior_sheet_data}{\code{wbWorksheet$get_prior_sheet_data()}} -\item \href{#method-wbWorksheet-get_post_sheet_data}{\code{wbWorksheet$get_post_sheet_data()}} -\item \href{#method-wbWorksheet-unfold_cols}{\code{wbWorksheet$unfold_cols()}} -\item \href{#method-wbWorksheet-fold_cols}{\code{wbWorksheet$fold_cols()}} -\item \href{#method-wbWorksheet-merge_cells}{\code{wbWorksheet$merge_cells()}} -\item \href{#method-wbWorksheet-unmerge_cells}{\code{wbWorksheet$unmerge_cells()}} -\item \href{#method-wbWorksheet-clean_sheet}{\code{wbWorksheet$clean_sheet()}} -\item \href{#method-wbWorksheet-add_page_break}{\code{wbWorksheet$add_page_break()}} -\item \href{#method-wbWorksheet-set_print_options}{\code{wbWorksheet$set_print_options()}} -\item \href{#method-wbWorksheet-append}{\code{wbWorksheet$append()}} -\item \href{#method-wbWorksheet-add_sparklines}{\code{wbWorksheet$add_sparklines()}} -\item \href{#method-wbWorksheet-set_sheetview}{\code{wbWorksheet$set_sheetview()}} -\item \href{#method-wbWorksheet-ignore_error}{\code{wbWorksheet$ignore_error()}} -\item \href{#method-wbWorksheet-clone}{\code{wbWorksheet$clone()}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-new}{}}} -\subsection{Method \code{new()}}{ -Creates a new \code{wbWorksheet} object -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$new( - tab_color = NULL, - odd_header = NULL, - odd_footer = NULL, - even_header = NULL, - even_footer = NULL, - first_header = NULL, - first_footer = NULL, - paper_size = 9, - orientation = "portrait", - hdpi = 300, - vdpi = 300, - grid_lines = FALSE, - ... -)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{tab_color}}{tabColor} - -\item{\code{odd_header}}{oddHeader} - -\item{\code{odd_footer}}{oddFooter} - -\item{\code{even_header}}{evenHeader} - -\item{\code{even_footer}}{evenFooter} - -\item{\code{first_header}}{firstHeader} - -\item{\code{first_footer}}{firstFooter} - -\item{\code{paper_size}}{paperSize} - -\item{\code{orientation}}{orientation} - -\item{\code{hdpi}}{hdpi} - -\item{\code{vdpi}}{vdpi} - -\item{\code{grid_lines}}{printGridLines} - -\item{\code{...}}{additional arguments} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -a \code{wbWorksheet} object -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-get_prior_sheet_data}{}}} -\subsection{Method \code{get_prior_sheet_data()}}{ -Get prior sheet data -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$get_prior_sheet_data()}\if{html}{\out{
}} -} - -\subsection{Returns}{ -A character vector of xml -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-get_post_sheet_data}{}}} -\subsection{Method \code{get_post_sheet_data()}}{ -Get post sheet data -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$get_post_sheet_data()}\if{html}{\out{
}} -} - -\subsection{Returns}{ -A character vector of xml -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-unfold_cols}{}}} -\subsection{Method \code{unfold_cols()}}{ -unfold \verb{} node to dataframe. \verb{} are compressed. -Only columns with attributes are written to the file. This function -unfolds them so that each cell beginning with the "A" to the last one -found in cc gets a value. -TODO might extend this to match either largest cc or largest col. Could -be that "Z" is formatted, but the last value is written to "Y". -TODO might replace the xml nodes with the data frame? -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$unfold_cols()}\if{html}{\out{
}} -} - -\subsection{Returns}{ -The column data frame -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-fold_cols}{}}} -\subsection{Method \code{fold_cols()}}{ -fold the column dataframe back into a node. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$fold_cols(col_df)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{col_df}}{the column data frame} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorksheetObject}, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-merge_cells}{}}} -\subsection{Method \code{merge_cells()}}{ -Set cell merging for a sheet -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$merge_cells(rows = NULL, cols = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{rows, cols}}{Row and column specifications.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorkbook} object, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-unmerge_cells}{}}} -\subsection{Method \code{unmerge_cells()}}{ -Removes cell merging for a sheet -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$unmerge_cells(rows = NULL, cols = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{rows, cols}}{Row and column specifications.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorkbook} object, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-clean_sheet}{}}} -\subsection{Method \code{clean_sheet()}}{ -clean sheet (remove all values) -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$clean_sheet( - dims = NULL, - numbers = TRUE, - characters = TRUE, - styles = TRUE, - merged_cells = TRUE -)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{dims}}{dimensions} - -\item{\code{numbers}}{remove all numbers} - -\item{\code{characters}}{remove all characters} - -\item{\code{styles}}{remove all styles} - -\item{\code{merged_cells}}{remove all merged_cells} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorksheetObject}, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-add_page_break}{}}} -\subsection{Method \code{add_page_break()}}{ -add page break -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$add_page_break(row = NULL, col = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{row}}{row} - -\item{\code{col}}{col} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-set_print_options}{}}} -\subsection{Method \code{set_print_options()}}{ -add print options -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$set_print_options( - gridLines = NULL, - gridLinesSet = NULL, - headings = NULL, - horizontalCentered = NULL, - verticalCentered = NULL -)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{gridLines}}{gridLines} - -\item{\code{gridLinesSet}}{gridLinesSet} - -\item{\code{headings}}{If TRUE prints row and column headings} - -\item{\code{horizontalCentered}}{If TRUE the page is horizontally centered} - -\item{\code{verticalCentered}}{If TRUE the page is vertically centered} -} -\if{html}{\out{
}} -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-append}{}}} -\subsection{Method \code{append()}}{ -append a field. Intended for internal use only. Not -guaranteed to remain a public method. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$append(field, value = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{field}}{a field name} - -\item{\code{value}}{a new value} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorksheetObject}, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-add_sparklines}{}}} -\subsection{Method \code{add_sparklines()}}{ -add sparkline -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$add_sparklines(sparklines)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{sparklines}}{sparkline created by \code{create_sparkline()}} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorksheetObject}, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-set_sheetview}{}}} -\subsection{Method \code{set_sheetview()}}{ -add sheetview -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$set_sheetview( - color_id = NULL, - default_grid_color = NULL, - right_to_left = NULL, - show_formulas = NULL, - show_grid_lines = NULL, - show_outline_symbols = NULL, - show_row_col_headers = NULL, - show_ruler = NULL, - show_white_space = NULL, - show_zeros = NULL, - tab_selected = NULL, - top_left_cell = NULL, - view = NULL, - window_protection = NULL, - workbook_view_id = NULL, - zoom_scale = NULL, - zoom_scale_normal = NULL, - zoom_scale_page_layout_view = NULL, - zoom_scale_sheet_layout_view = NULL, - ... -)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{color_id, default_grid_color}}{Integer: A color, default is 64} - -\item{\code{right_to_left}}{Logical: if TRUE column ordering is right to left} - -\item{\code{show_formulas}}{Logical: if TRUE cell formulas are shown} - -\item{\code{show_grid_lines}}{Logical: if TRUE the worksheet grid is shown} - -\item{\code{show_outline_symbols}}{Logical: if TRUE outline symbols are shown} - -\item{\code{show_row_col_headers}}{Logical: if TRUE row and column headers are shown} - -\item{\code{show_ruler}}{Logical: if TRUE a ruler is shown in page layout view} - -\item{\code{show_white_space}}{Logical: if TRUE margins are shown in page layout view} - -\item{\code{show_zeros}}{Logical: if FALSE cells containing zero are shown blank if !showFormulas} - -\item{\code{tab_selected}}{Integer: zero vector indicating the selected tab} - -\item{\code{top_left_cell}}{Cell: the cell shown in the top left corner / or top right with rightToLeft} - -\item{\code{view}}{View: "normal", "pageBreakPreview" or "pageLayout"} - -\item{\code{window_protection}}{Logical: if TRUE the panes are protected} - -\item{\code{workbook_view_id}}{integer: Pointing to some other view inside the workbook} - -\item{\code{zoom_scale, zoom_scale_normal, zoom_scale_page_layout_view, zoom_scale_sheet_layout_view}}{Integer: the zoom scale should be between 10 and 400. These are values for current, normal etc.} - -\item{\code{...}}{additional arguments} - -\item{\code{sheet}}{sheet} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorksheetObject}, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-ignore_error}{}}} -\subsection{Method \code{ignore_error()}}{ -Ignore error on worksheet -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$ignore_error( - dims = "A1", - calculatedColumn = FALSE, - emptyCellReference = FALSE, - evalError = FALSE, - formula = FALSE, - formulaRange = FALSE, - listDataValidation = FALSE, - numberStoredAsText = FALSE, - twoDigitTextYear = FALSE, - unlockedFormula = FALSE -)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{dims}}{dims} - -\item{\code{calculatedColumn}}{calculatedColumn} - -\item{\code{emptyCellReference}}{emptyCellReference} - -\item{\code{evalError}}{evalError} - -\item{\code{formula}}{formula} - -\item{\code{formulaRange}}{formulaRange} - -\item{\code{listDataValidation}}{listDataValidation} - -\item{\code{numberStoredAsText}}{numberStoredAsText} - -\item{\code{twoDigitTextYear}}{twoDigitTextYear} - -\item{\code{unlockedFormula}}{unlockedFormula} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{wbWorksheetObject}, invisibly -} -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-wbWorksheet-clone}{}}} -\subsection{Method \code{clone()}}{ -The objects of this class are cloneable with this method. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{wbWorksheet$clone(deep = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{deep}}{Whether to make a deep clone.} -} -\if{html}{\out{
}} -} -} -} diff --git a/man/write_file.Rd b/man/write_file.Rd deleted file mode 100644 index 97aa90642..000000000 --- a/man/write_file.Rd +++ /dev/null @@ -1,23 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/pugixml.R -\name{write_file} -\alias{write_file} -\title{write xml file} -\usage{ -write_file(head = "", body = "", tail = "", fl = "", escapes = FALSE) -} -\arguments{ -\item{head}{head part of xml} - -\item{body}{body part of xml} - -\item{tail}{tail part of xml} - -\item{fl}{file name with full path} - -\item{escapes}{bool if characters like "&" should be escaped. The default is -no escape, assuming that xml to export is already valid.} -} -\description{ -brings the added benefit of xml checking -}