doc: refactor doc about flextable selectors

Author: davidgohel

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: flextable
 Title: Functions for Tabular Reporting
-Version: 0.9.11.005
+Version: 0.9.11.006
 Authors@R: c(
     person("David", "Gohel", , "[email protected]", role = c("aut", "cre")),
     person("ArData", role = "cph"),

R/append_chunk.R

@@ -2,12 +2,9 @@
 #' @title Append chunks to flextable content
 #' @description append chunks (for example chunk [as_chunk()])
 #' in a flextable.
-#' @param x a flextable object
+#' @inheritParams args_selectors_without_all
 #' @param ... chunks to be appened, see [as_chunk()], [gg_chunk()] and other
 #' chunk elements for paragraph.
-#' @param i rows selection
-#' @param j column selection
-#' @param part partname of the table (one of 'body', 'header', 'footer')
 #' @seealso [as_chunk()], [as_sup()], [as_sub()], [colorize()]
 #' @family functions for mixed content paragraphs
 #' @examples
@@ -60,12 +57,9 @@ append_chunks <- function(x, ..., i = NULL, j = NULL, part = "body") {
 #' @title Prepend chunks to flextable content
 #' @description prepend chunks (for example chunk [as_chunk()])
 #' in a flextable.
-#' @param x a flextable object
+#' @inheritParams args_selectors_without_all
 #' @param ... chunks to be prepended, see [as_chunk()], [gg_chunk()] and other
 #' chunk elements for paragraph.
-#' @param i rows selection
-#' @param j column selection
-#' @param part partname of the table (one of 'body', 'header', 'footer')
 #' @family functions for mixed content paragraphs
 #' @examples
 #' x <- flextable(head(iris))

R/augment_rows.R

@@ -3,7 +3,7 @@
 #' @description This function set labels for specified
 #' columns in the bottom row header of a flextable.
 #'
-#' @param x a `flextable` object
+#' @inheritParams args_x_only
 #' @param ... named arguments (names are data colnames), each element is a single character
 #' value specifying label to use.
 #' @param values a named list (names are data colnames), each element is a single character
@@ -103,8 +103,7 @@ set_header_labels <- function(x, ..., values = NULL) {
 #' @description indicate to not print a part of
 #' the flextable, i.e. an header, footer or the body.
 #'
-#' @param x a `flextable` object
-#' @param part partname of the table to delete (one of 'body', 'header' or 'footer').
+#' @inheritParams args_x_part_no_all
 #' @family functions for row and column operations in a flextable
 #' @examples
 #' ft <- flextable(head(iris))
@@ -157,10 +156,7 @@ delete_rows_from_part <- function(x, i) {
 #' of any span parameters that may have been set previously.
 #' They will have to be redone after this operation or
 #' performed only after this deletion.
-#' @param x a `flextable` object
-#' @param i rows selection
-#' @param part partname of the table (one of 'all', 'body', 'header', 'footer')
-#' @family functions for row and column operations in a flextable
+#' @inheritParams args_x_i_part
 #' @examples
 #' ft <- flextable(head(iris))
 #' ft <- delete_rows(ft, i = 1:5, part = "body")
@@ -222,8 +218,7 @@ delete_colums_from_part <- function(x, j) {
 #' of any span parameters that may have been set previously.
 #' They will have to be redone after this operation or
 #' performed only after this deletion.
-#' @param x a `flextable` object
-#' @param j columns selection
+#' @inheritParams args_x_j
 #' @family functions for row and column operations in a flextable
 #' @examples
 #' ft <- flextable(head(iris))
@@ -317,7 +312,7 @@ add_rows_to_tabpart <- function(x, rows, first = FALSE) {
 #'
 #' If some columns are not provided, they will be replaced by
 #' `NA` and displayed as empty.
-#' @param x a flextable object
+#' @inheritParams args_x_only
 #' @param top should the rows be inserted at the top or the bottom.
 #' @param ... named arguments (names are data colnames) of values
 #' to add. It is important to insert data of the same type as the
@@ -480,7 +475,7 @@ add_footer <- function(x, top = TRUE, ..., values = NULL) {
 #'
 #' Labels can also be formatted with [as_paragraph()].
 #'
-#' @param x a flextable object
+#' @inheritParams args_x_only
 #' @param top should the row be inserted at the top or the bottom.
 #' @param values values to add. It can be a `list`, a `character()` vector
 #' or a call to [as_paragraph()].
@@ -605,7 +600,7 @@ add_body_row <- function(x, top = TRUE, values = list(), colwidths = integer(0))
 #'
 #' Labels can also be formatted with [as_paragraph()].
 #'
-#' @param x a flextable object
+#' @inheritParams args_x_only
 #' @param top should the row be inserted at the
 #' top or the bottom. Default to TRUE.
 #' @param values values to add, a character vector (as header rows
@@ -825,13 +820,13 @@ data_from_char <- function(values, colwidths, col_keys) {
 #' add labels in the header, most of the time it will
 #' be used to adding titles on the top rows of the flextable.
 #'
-#' @param x a `flextable` object
+#' @inheritParams args_x_only
 #' @param values a character vector or a call to [as_paragraph()]
 #' to get formated content, each element will
 #' be added as a new row.
 #' @param top should the row be inserted at the top
 #' or the bottom. Default to TRUE.
-#' @family functions that add rows in the table
+#' @family functions for row and column operations in a flextable
 #' @examples
 #' # ex 1----
 #' ft_1 <- flextable(head(iris))
@@ -993,7 +988,7 @@ set_part_df <- function(x, mapping = NULL, key = "col_keys", part) {
 #' is used as the top header/footer row and the rightmost column
 #' is used as the bottom header/footer row.
 #'
-#' @param x a `flextable` object
+#' @inheritParams args_x_only
 #' @param mapping a `data.frame` specyfing for each colname
 #' content of the column.
 #' @param key column to use as key when joigning data_mapping.
@@ -1059,7 +1054,7 @@ set_footer_df <- function(x, mapping = NULL, key = "col_keys") {
 #' \if{html}{\out{
 #' <img src="https://www.ardata.fr/img/flextable-imgs/flextable-016.png" alt="add_header illustration" style="width:100\%;">
 #' }}
-#' @param x a flextable object
+#' @inheritParams args_x_only
 #' @param opts Optional treatments to apply to the resulting header part.
 #' This should be a character vector with support for multiple values.
 #'

R/border_fix.R

@@ -8,8 +8,7 @@
 #'
 #' Note since version `0.9.7` that the function is called automatically
 #' before rendering, user should not have to call this function anymore.
-#' @param x flextable object
-#' @param part partname of the table (one of 'all', 'body', 'header', 'footer')
+#' @inheritParams args_x_part
 #' @examples
 #' library(officer)
 #' dat <- data.frame(a = 1:5, b = 6:10)