Merge pull request #657 from davidgohel/fix-doc-package-links

fix : update in-doc links for new R release

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", , "[email protected]", role = c("aut", "cre")),
     person("ArData", role = "cph"),

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
 

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`.

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()].

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)

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

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`.

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

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

R/printers.R

@@ -2,10 +2,10 @@
 #' @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
+#' @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'.
@@ -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

R/rtf_str.R

@@ -193,9 +193,9 @@ 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 x rtf object, created by [officer::rtf_doc()].
 #' @param value a flextable object
 #' @param ... unused arguments
 #' @examples

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(...) {