From 445690a99445c2eb6e1ed814aae2b99654be45e3 Mon Sep 17 00:00:00 2001 From: elidaniels Date: Mon, 2 Sep 2024 15:14:59 +0200 Subject: [PATCH 1/3] fix : update in-doc links for new R release --- DESCRIPTION | 2 +- NEWS.md | 2 +- R/as_flextable.tabular.R | 2 +- R/as_flextable_tabulator.R | 2 +- R/borders.R | 2 +- R/defaults.R | 4 ++-- R/flextable.R | 2 +- R/grid_grobs.R | 2 +- R/latex_str.R | 2 +- R/printers.R | 6 +++--- R/rtf_str.R | 2 +- R/zz-defunct.R | 4 ++-- man/add_latex_dep.Rd | 2 +- man/as_flextable.tabular.Rd | 2 +- man/as_flextable.tabulator.Rd | 2 +- man/border_inner.Rd | 2 +- man/border_inner_h.Rd | 2 +- man/border_inner_v.Rd | 2 +- man/border_outer.Rd | 2 +- man/flextable-package.Rd | 2 +- man/footers_flextable_at_bkm.Rd | 2 +- man/fp_border_default.Rd | 2 +- man/fp_text_default.Rd | 2 +- man/gen_grob.Rd | 2 +- man/headers_flextable_at_bkm.Rd | 2 +- man/hline.Rd | 2 +- man/hline_bottom.Rd | 2 +- man/hline_top.Rd | 2 +- man/htmltools_value.Rd | 2 +- man/rtf_add.flextable.Rd | 2 +- man/save_as_docx.Rd | 2 +- man/save_as_rtf.Rd | 2 +- man/set_caption.Rd | 2 +- man/vline.Rd | 2 +- man/vline_left.Rd | 2 +- man/vline_right.Rd | 2 +- 36 files changed, 40 insertions(+), 40 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 86bd2bdb..0b8dff25 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Type: Package Package: flextable Title: Functions for Tabular Reporting -Version: 0.9.7.009 +Version: 0.9.7.010 Authors@R: c( person("David", "Gohel", , "david.gohel@ardata.fr", role = c("aut", "cre")), person("ArData", role = "cph"), diff --git a/NEWS.md b/NEWS.md index 940b6a15..9554e5ce 100644 --- a/NEWS.md +++ b/NEWS.md @@ -360,7 +360,7 @@ with the argument `align_with_table=FALSE`. - new theme 'APA', `theme_apa` (@rempsyc #426) - method `as_flextable.tabulator()` gains an argument `spread_first_col` to enable spreading of the first column of the table as a line separator. - +- fix doc links to functions from other packages for future releases ## Issues diff --git a/R/as_flextable.tabular.R b/R/as_flextable.tabular.R index 58470b3a..9a19c65e 100644 --- a/R/as_flextable.tabular.R +++ b/R/as_flextable.tabular.R @@ -26,7 +26,7 @@ #' instead of being a column. This helps to reduce the width and allows for #' clear divisions. #' @param fp_p paragraph formatting properties associated with row titles, -#' see [fp_par()]. +#' see [officer::fp_par()]. #' @param row_title a call to [as_paragraph()] - it #' will be applied to the row titles if any #' when `spread_first_col=TRUE`. diff --git a/R/as_flextable_tabulator.R b/R/as_flextable_tabulator.R index ba81462d..1de15acc 100644 --- a/R/as_flextable_tabulator.R +++ b/R/as_flextable_tabulator.R @@ -213,7 +213,7 @@ tabulator <- function(x, rows, columns, #' @param separate_with columns used to sepatate the groups #' with an horizontal line. #' @param big_border,small_border big and small border properties defined -#' by a call to [fp_border_default()] or [fp_border()]. +#' by a call to [fp_border_default()] or [officer::fp_border()]. #' @param rows_alignment,columns_alignment alignments to apply to #' columns corresponding to `rows` and `columns`; see arguments #' `rows` and `columns` in [tabulator()]. diff --git a/R/borders.R b/R/borders.R index 8e1a63f7..17bb2321 100644 --- a/R/borders.R +++ b/R/borders.R @@ -133,7 +133,7 @@ border_remove <- function(x) { #' or all parts of a flextable. #' @param x a flextable object #' @param part partname of the table (one of 'all', 'body', 'header', 'footer') -#' @param border border properties defined by a call to [fp_border()] +#' @param border border properties defined by a call to [officer::fp_border()] #' @export #' @examples #' library(officer) diff --git a/R/defaults.R b/R/defaults.R index 80aeaf91..f1c2c5c7 100644 --- a/R/defaults.R +++ b/R/defaults.R @@ -373,7 +373,7 @@ print.flextable_defaults <- function(x, ...) { #' @inheritParams officer::fp_text #' @title Text formatting properties #' -#' @description Create a [fp_text()] object that uses +#' @description Create a [officer::fp_text()] object that uses #' defaut values defined in the flextable it applies to. #' #' `fp_text_default()` is a handy function that will allow @@ -441,7 +441,7 @@ fp_text_default <- function(color = flextable_global$defaults$font.color, #' @inheritParams officer::fp_border #' @title Border formatting properties #' -#' @description Create a [fp_border()] object that uses +#' @description Create a [officer::fp_border()] object that uses #' defaut values defined in flextable defaults formatting properties, i.e. #' default border color (see [set_flextable_defaults()]). #' @examples diff --git a/R/flextable.R b/R/flextable.R index a95240df..51ef60ef 100644 --- a/R/flextable.R +++ b/R/flextable.R @@ -296,7 +296,7 @@ qflextable <- function(data) { #' is deprecated in favor of `word_stylename`. If the caption is defined with #' `as_paragraph()`, some of the formattings of the paragraph style will be #' replaced by the formattings associated with the chunks (such as the font). -#' @param fp_p paragraph formatting properties associated with the caption, see [fp_par()]. +#' @param fp_p paragraph formatting properties associated with the caption, see [officer::fp_par()]. #' It applies when possible, i.e. in HTML and 'Word' but not with bookdown. #' @param align_with_table if TRUE, caption is aligned as the flextable, if FALSE, #' `fp_p` will not be updated and alignement is as defined with `fp_p`. diff --git a/R/grid_grobs.R b/R/grid_grobs.R index d99e7aa4..8186ee4c 100644 --- a/R/grid_grobs.R +++ b/R/grid_grobs.R @@ -19,7 +19,7 @@ #' It is not recommended to use this function for #' large tables because the calculations can be long. #' -#' Limitations: equations (see [as_equation()]) and hyperlinks (see [hyperlink_ftext()]) +#' Limitations: equations (see [as_equation()]) and hyperlinks (see [officer::hyperlink_ftext()]) #' will not be displayed. #' #' @inheritSection save_as_image caption diff --git a/R/latex_str.R b/R/latex_str.R index c8b30204..5e300ca2 100644 --- a/R/latex_str.R +++ b/R/latex_str.R @@ -1,7 +1,7 @@ #' @export #' @title Add latex dependencies #' @description Manually add flextable latex dependencies to -#' the knitr session via [knit_meta_add()]. +#' the knitr session via [knitr::knit_meta_add()]. #' #' When enabling caching in 'R Markdown' documents for PDF output, #' the flextable cached result is used directly. Call `add_latex_dep()` in a diff --git a/R/printers.R b/R/printers.R index 25826cd4..7a18c41d 100644 --- a/R/printers.R +++ b/R/printers.R @@ -2,7 +2,7 @@ #' @export #' @title flextable as an 'HTML' object #' -#' @description get a [div()] from a flextable object. +#' @description get a [htmltools::div()] from a flextable object. #' This can be used in a shiny application. For an output within #' "R Markdown" document, use [knit_print.flextable]. #' @return an object marked as [HTML] ready to be used within @@ -810,7 +810,7 @@ save_as_pptx <- function(..., values = NULL, path) { #' @param values a list (possibly named), each element is a flextable object. If named objects, names are #' used as titles. If provided, argument `...` will be ignored. #' @param path Word file to be created -#' @param pr_section a [prop_section] object that can be used to define page +#' @param pr_section a [officer::prop_section] object that can be used to define page #' layout such as orientation, width and height. #' @param align left, center (default) or right. #' @return a string containing the full name of the generated file @@ -885,7 +885,7 @@ save_as_docx <- function(..., values = NULL, path, pr_section = NULL, align = "c #' @param values a list (possibly named), each element is a flextable object. If named objects, names are #' used as titles. If provided, argument `...` will be ignored. #' @param path Word file to be created -#' @param pr_section a [prop_section] object that can be used to define page +#' @param pr_section a [officer::prop_section] object that can be used to define page #' layout such as orientation, width and height. #' @return a string containing the full name of the generated file #' @family flextable print function diff --git a/R/rtf_str.R b/R/rtf_str.R index 0c14e893..b0ecc9c1 100644 --- a/R/rtf_str.R +++ b/R/rtf_str.R @@ -193,7 +193,7 @@ to_rtf.flextable <- function(x, topcaption = TRUE, ...) { #' @export #' @importFrom officer rtf_add #' @title Add a 'flextable' into an RTF document -#' @description [rtf_add()] method for adding +#' @description [officer::rtf_add()] method for adding #' flextable objects into 'RTF' documents. #' @param x rtf object, created by [rtf_doc()]. #' @param value a flextable object diff --git a/R/zz-defunct.R b/R/zz-defunct.R index bf1b4c9b..c30e4c7a 100644 --- a/R/zz-defunct.R +++ b/R/zz-defunct.R @@ -1,6 +1,6 @@ #' @export #' @title Add flextable at a bookmark location in document's header -#' @description Function is now defunct, use [prop_section()] instead. +#' @description Function is now defunct, use [officer::prop_section()] instead. #' @param ... unused #' @keywords internal headers_flextable_at_bkm <- function(...) { @@ -9,7 +9,7 @@ headers_flextable_at_bkm <- function(...) { #' @export #' @title Add flextable at a bookmark location in document's footer -#' @description Function is now defunct, use [prop_section()] instead. +#' @description Function is now defunct, use [officer::prop_section()] instead. #' @param ... unused #' @keywords internal footers_flextable_at_bkm <- function(...) { diff --git a/man/add_latex_dep.Rd b/man/add_latex_dep.Rd index f3f000cd..25358ad3 100644 --- a/man/add_latex_dep.Rd +++ b/man/add_latex_dep.Rd @@ -13,7 +13,7 @@ add_latex_dep(float = FALSE, wrapfig = FALSE) } \description{ Manually add flextable latex dependencies to -the knitr session via \code{\link[=knit_meta_add]{knit_meta_add()}}. +the knitr session via \code{\link[knitr:knit_meta]{knitr::knit_meta_add()}}. When enabling caching in 'R Markdown' documents for PDF output, the flextable cached result is used directly. Call \code{add_latex_dep()} in a diff --git a/man/as_flextable.tabular.Rd b/man/as_flextable.tabular.Rd index ce789aad..2db9e765 100644 --- a/man/as_flextable.tabular.Rd +++ b/man/as_flextable.tabular.Rd @@ -21,7 +21,7 @@ instead of being a column. This helps to reduce the width and allows for clear divisions.} \item{fp_p}{paragraph formatting properties associated with row titles, -see \code{\link[=fp_par]{fp_par()}}.} +see \code{\link[officer:fp_par]{officer::fp_par()}}.} \item{row_title}{a call to \code{\link[=as_paragraph]{as_paragraph()}} - it will be applied to the row titles if any diff --git a/man/as_flextable.tabulator.Rd b/man/as_flextable.tabulator.Rd index e499fa66..2e8d40fb 100644 --- a/man/as_flextable.tabulator.Rd +++ b/man/as_flextable.tabulator.Rd @@ -26,7 +26,7 @@ with an horizontal line.} \item{big_border, small_border}{big and small border properties defined -by a call to \code{\link[=fp_border_default]{fp_border_default()}} or \code{\link[=fp_border]{fp_border()}}.} +by a call to \code{\link[=fp_border_default]{fp_border_default()}} or \code{\link[officer:fp_border]{officer::fp_border()}}.} \item{rows_alignment, columns_alignment}{alignments to apply to columns corresponding to \code{rows} and \code{columns}; see arguments diff --git a/man/border_inner.Rd b/man/border_inner.Rd index 69ddba01..2a0af6ab 100644 --- a/man/border_inner.Rd +++ b/man/border_inner.Rd @@ -9,7 +9,7 @@ border_inner(x, border = NULL, part = "all") \arguments{ \item{x}{a flextable object} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/border_inner_h.Rd b/man/border_inner_h.Rd index 2844c902..cb7d118a 100644 --- a/man/border_inner_h.Rd +++ b/man/border_inner_h.Rd @@ -9,7 +9,7 @@ border_inner_h(x, border = NULL, part = "body") \arguments{ \item{x}{a flextable object} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/border_inner_v.Rd b/man/border_inner_v.Rd index 51763565..9600bb42 100644 --- a/man/border_inner_v.Rd +++ b/man/border_inner_v.Rd @@ -9,7 +9,7 @@ border_inner_v(x, border = NULL, part = "all") \arguments{ \item{x}{a flextable object} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/border_outer.Rd b/man/border_outer.Rd index 95149351..34fb6f38 100644 --- a/man/border_outer.Rd +++ b/man/border_outer.Rd @@ -9,7 +9,7 @@ border_outer(x, border = NULL, part = "all") \arguments{ \item{x}{a flextable object} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/flextable-package.Rd b/man/flextable-package.Rd index 5f3de4d7..4d6baae6 100644 --- a/man/flextable-package.Rd +++ b/man/flextable-package.Rd @@ -41,6 +41,7 @@ Other contributors: \itemize{ \item ArData [copyright holder] \item Clementine Jager [contributor] + \item Eli Daniels [contributor] \item Quentin Fazilleau [contributor] \item Maxim Nazarov (rmarkdown for docx output) [contributor] \item Titouan Robert [contributor] @@ -51,7 +52,6 @@ Other contributors: \item Rémi Thériault (\href{https://orcid.org/0000-0003-4315-6788}{ORCID}) (theme_apa) [contributor] \item Samuel Jobert (work on pagination) [contributor] \item Keith Newman [contributor] - \item Eli Daniels [contributor] } } diff --git a/man/footers_flextable_at_bkm.Rd b/man/footers_flextable_at_bkm.Rd index 952dce95..564db2e1 100644 --- a/man/footers_flextable_at_bkm.Rd +++ b/man/footers_flextable_at_bkm.Rd @@ -10,6 +10,6 @@ footers_flextable_at_bkm(...) \item{...}{unused} } \description{ -Function is now defunct, use \code{\link[=prop_section]{prop_section()}} instead. +Function is now defunct, use \code{\link[officer:prop_section]{officer::prop_section()}} instead. } \keyword{internal} diff --git a/man/fp_border_default.Rd b/man/fp_border_default.Rd index e0a24618..297c1882 100644 --- a/man/fp_border_default.Rd +++ b/man/fp_border_default.Rd @@ -19,7 +19,7 @@ border styles.} \item{width}{border width - an integer value : 0>= value} } \description{ -Create a \code{\link[=fp_border]{fp_border()}} object that uses +Create a \code{\link[officer:fp_border]{officer::fp_border()}} object that uses defaut values defined in flextable defaults formatting properties, i.e. default border color (see \code{\link[=set_flextable_defaults]{set_flextable_defaults()}}). } diff --git a/man/fp_text_default.Rd b/man/fp_text_default.Rd index c652a0bc..0b186d46 100644 --- a/man/fp_text_default.Rd +++ b/man/fp_text_default.Rd @@ -53,7 +53,7 @@ or \code{'subscript'} or \code{'superscript'}} a valid color (e.g. "#000000" or "black").} } \description{ -Create a \code{\link[=fp_text]{fp_text()}} object that uses +Create a \code{\link[officer:fp_text]{officer::fp_text()}} object that uses defaut values defined in the flextable it applies to. \code{fp_text_default()} is a handy function that will allow diff --git a/man/gen_grob.Rd b/man/gen_grob.Rd index 794e8ff5..33481594 100644 --- a/man/gen_grob.Rd +++ b/man/gen_grob.Rd @@ -90,7 +90,7 @@ freeze or not the size of the columns. It is not recommended to use this function for large tables because the calculations can be long. -Limitations: equations (see \code{\link[=as_equation]{as_equation()}}) and hyperlinks (see \code{\link[=hyperlink_ftext]{hyperlink_ftext()}}) +Limitations: equations (see \code{\link[=as_equation]{as_equation()}}) and hyperlinks (see \code{\link[officer:hyperlink_ftext]{officer::hyperlink_ftext()}}) will not be displayed. } \section{size}{ diff --git a/man/headers_flextable_at_bkm.Rd b/man/headers_flextable_at_bkm.Rd index 1c56035a..ddf8881a 100644 --- a/man/headers_flextable_at_bkm.Rd +++ b/man/headers_flextable_at_bkm.Rd @@ -10,6 +10,6 @@ headers_flextable_at_bkm(...) \item{...}{unused} } \description{ -Function is now defunct, use \code{\link[=prop_section]{prop_section()}} instead. +Function is now defunct, use \code{\link[officer:prop_section]{officer::prop_section()}} instead. } \keyword{internal} diff --git a/man/hline.Rd b/man/hline.Rd index 91291466..41a66b45 100644 --- a/man/hline.Rd +++ b/man/hline.Rd @@ -13,7 +13,7 @@ hline(x, i = NULL, j = NULL, border = NULL, part = "body") \item{j}{columns selection} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/hline_bottom.Rd b/man/hline_bottom.Rd index b8829a67..fe1d5a66 100644 --- a/man/hline_bottom.Rd +++ b/man/hline_bottom.Rd @@ -11,7 +11,7 @@ hline_bottom(x, j = NULL, border = NULL, part = "body") \item{j}{columns selection} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/hline_top.Rd b/man/hline_top.Rd index 42d893dc..83a00989 100644 --- a/man/hline_top.Rd +++ b/man/hline_top.Rd @@ -11,7 +11,7 @@ hline_top(x, j = NULL, border = NULL, part = "body") \item{j}{columns selection} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/htmltools_value.Rd b/man/htmltools_value.Rd index 8975b1ea..24e91b79 100644 --- a/man/htmltools_value.Rd +++ b/man/htmltools_value.Rd @@ -26,7 +26,7 @@ an object marked as \link{HTML} ready to be used within a call to \code{shiny::renderUI} for example. } \description{ -get a \code{\link[=div]{div()}} from a flextable object. +get a \code{\link[htmltools:builder]{htmltools::div()}} from a flextable object. This can be used in a shiny application. For an output within "R Markdown" document, use \link{knit_print.flextable}. } diff --git a/man/rtf_add.flextable.Rd b/man/rtf_add.flextable.Rd index 3d0c6a02..98799496 100644 --- a/man/rtf_add.flextable.Rd +++ b/man/rtf_add.flextable.Rd @@ -14,7 +14,7 @@ \item{...}{unused arguments} } \description{ -\code{\link[=rtf_add]{rtf_add()}} method for adding +\code{\link[officer:rtf_add]{officer::rtf_add()}} method for adding flextable objects into 'RTF' documents. } \examples{ diff --git a/man/save_as_docx.Rd b/man/save_as_docx.Rd index f16daddd..66289bc7 100644 --- a/man/save_as_docx.Rd +++ b/man/save_as_docx.Rd @@ -15,7 +15,7 @@ used as titles. If provided, argument \code{...} will be ignored.} \item{path}{Word file to be created} -\item{pr_section}{a \link{prop_section} object that can be used to define page +\item{pr_section}{a \link[officer:prop_section]{officer::prop_section} object that can be used to define page layout such as orientation, width and height.} \item{align}{left, center (default) or right.} diff --git a/man/save_as_rtf.Rd b/man/save_as_rtf.Rd index e06082e9..4d8233ff 100644 --- a/man/save_as_rtf.Rd +++ b/man/save_as_rtf.Rd @@ -15,7 +15,7 @@ used as titles. If provided, argument \code{...} will be ignored.} \item{path}{Word file to be created} -\item{pr_section}{a \link{prop_section} object that can be used to define page +\item{pr_section}{a \link[officer:prop_section]{officer::prop_section} object that can be used to define page layout such as orientation, width and height.} } \value{ diff --git a/man/set_caption.Rd b/man/set_caption.Rd index 0d8263a0..aa587dea 100644 --- a/man/set_caption.Rd +++ b/man/set_caption.Rd @@ -40,7 +40,7 @@ is deprecated in favor of \code{word_stylename}. If the caption is defined with \code{as_paragraph()}, some of the formattings of the paragraph style will be replaced by the formattings associated with the chunks (such as the font).} -\item{fp_p}{paragraph formatting properties associated with the caption, see \code{\link[=fp_par]{fp_par()}}. +\item{fp_p}{paragraph formatting properties associated with the caption, see \code{\link[officer:fp_par]{officer::fp_par()}}. It applies when possible, i.e. in HTML and 'Word' but not with bookdown.} \item{align_with_table}{if TRUE, caption is aligned as the flextable, if FALSE, diff --git a/man/vline.Rd b/man/vline.Rd index db3dd549..b5d4dcd4 100644 --- a/man/vline.Rd +++ b/man/vline.Rd @@ -13,7 +13,7 @@ vline(x, i = NULL, j = NULL, border = NULL, part = "all") \item{j}{columns selection} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/vline_left.Rd b/man/vline_left.Rd index f2691a26..897134c2 100644 --- a/man/vline_left.Rd +++ b/man/vline_left.Rd @@ -11,7 +11,7 @@ vline_left(x, i = NULL, border = NULL, part = "all") \item{i}{rows selection} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } diff --git a/man/vline_right.Rd b/man/vline_right.Rd index 14f2123b..2794da1b 100644 --- a/man/vline_right.Rd +++ b/man/vline_right.Rd @@ -11,7 +11,7 @@ vline_right(x, i = NULL, border = NULL, part = "all") \item{i}{rows selection} -\item{border}{border properties defined by a call to \code{\link[=fp_border]{fp_border()}}} +\item{border}{border properties defined by a call to \code{\link[officer:fp_border]{officer::fp_border()}}} \item{part}{partname of the table (one of 'all', 'body', 'header', 'footer')} } From e06fbd6533f8a90bcefa4a3030f1fb5b5e542180 Mon Sep 17 00:00:00 2001 From: elidaniels Date: Mon, 2 Sep 2024 15:28:23 +0200 Subject: [PATCH 2/3] fix: missed a couple --- R/printers.R | 2 +- R/rtf_str.R | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/printers.R b/R/printers.R index 7a18c41d..a4cb999b 100644 --- a/R/printers.R +++ b/R/printers.R @@ -5,7 +5,7 @@ #' @description get a [htmltools::div()] from a flextable object. #' This can be used in a shiny application. For an output within #' "R Markdown" document, use [knit_print.flextable]. -#' @return an object marked as [HTML] ready to be used within +#' @return an object marked as [htmltools::HTML] ready to be used within #' a call to `shiny::renderUI` for example. #' @param x a flextable object #' @param ft.align flextable alignment, supported values are 'left', 'center' and 'right'. diff --git a/R/rtf_str.R b/R/rtf_str.R index b0ecc9c1..a2950dba 100644 --- a/R/rtf_str.R +++ b/R/rtf_str.R @@ -195,7 +195,7 @@ to_rtf.flextable <- function(x, topcaption = TRUE, ...) { #' @title Add a 'flextable' into an RTF document #' @description [officer::rtf_add()] method for adding #' flextable objects into 'RTF' documents. -#' @param x rtf object, created by [rtf_doc()]. +#' @param x rtf object, created by [officer::rtf_doc()]. #' @param value a flextable object #' @param ... unused arguments #' @examples From 26134dd216648763517240aa9cc5084224c81129 Mon Sep 17 00:00:00 2001 From: elidaniels Date: Mon, 2 Sep 2024 15:41:43 +0200 Subject: [PATCH 3/3] fix : build changes to doc --- man/htmltools_value.Rd | 2 +- man/rtf_add.flextable.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/man/htmltools_value.Rd b/man/htmltools_value.Rd index 24e91b79..3474358c 100644 --- a/man/htmltools_value.Rd +++ b/man/htmltools_value.Rd @@ -22,7 +22,7 @@ htmltools_value( add in the HTML output.} } \value{ -an object marked as \link{HTML} ready to be used within +an object marked as \link[htmltools:HTML]{htmltools::HTML} ready to be used within a call to \code{shiny::renderUI} for example. } \description{ diff --git a/man/rtf_add.flextable.Rd b/man/rtf_add.flextable.Rd index 98799496..092cbdee 100644 --- a/man/rtf_add.flextable.Rd +++ b/man/rtf_add.flextable.Rd @@ -7,7 +7,7 @@ \method{rtf_add}{flextable}(x, value, ...) } \arguments{ -\item{x}{rtf object, created by \code{\link[=rtf_doc]{rtf_doc()}}.} +\item{x}{rtf object, created by \code{\link[officer:rtf_doc]{officer::rtf_doc()}}.} \item{value}{a flextable object}