add named character option to docs

easystats · Dec 18, 2024 · 3533bba · 3533bba
1 parent 60c2fa5
commit 3533bba
Show file tree

Hide file tree

Showing 36 changed files with 144 additions and 0 deletions.
diff --git a/R/extract_column_names.R b/R/extract_column_names.R
@@ -13,6 +13,10 @@
 #'     vector of variable names (e.g., `c("col1", "col2", "col3")`), or a
 #'     character vector of variable names including ranges specified via `:`
 #'     (e.g., `c("col1:col3", "col5")`),
+#'   - for some functions, like `data_select()` or `data_rename()`, `select` can
+#'     be a named character vector. In this case, the names are used to rename
+#'     the columns in the output data frame. See 'Details' in the related
+#'     functions to see where this option applies.
 #'   - a formula with variable names (e.g., `~column_1 + column_2`),
 #'   - a vector of positive integers, giving the positions counting from the left
 #'     (e.g. `1` or `c(1, 3, 5)`),

diff --git a/man/adjust.Rd b/man/adjust.Rd
diff --git a/man/assign_labels.Rd b/man/assign_labels.Rd
diff --git a/man/categorize.Rd b/man/categorize.Rd
diff --git a/man/center.Rd b/man/center.Rd
diff --git a/man/convert_na_to.Rd b/man/convert_na_to.Rd
diff --git a/man/convert_to_na.Rd b/man/convert_to_na.Rd
diff --git a/man/data_codebook.Rd b/man/data_codebook.Rd
diff --git a/man/data_duplicated.Rd b/man/data_duplicated.Rd
diff --git a/man/data_extract.Rd b/man/data_extract.Rd
diff --git a/man/data_group.Rd b/man/data_group.Rd
diff --git a/man/data_peek.Rd b/man/data_peek.Rd
diff --git a/man/data_prefix_suffix.Rd b/man/data_prefix_suffix.Rd
diff --git a/man/data_relocate.Rd b/man/data_relocate.Rd
diff --git a/man/data_rename.Rd b/man/data_rename.Rd
diff --git a/man/data_replicate.Rd b/man/data_replicate.Rd
diff --git a/man/data_separate.Rd b/man/data_separate.Rd
diff --git a/man/data_tabulate.Rd b/man/data_tabulate.Rd
diff --git a/man/data_to_long.Rd b/man/data_to_long.Rd
diff --git a/man/data_unique.Rd b/man/data_unique.Rd
diff --git a/man/data_unite.Rd b/man/data_unite.Rd
diff --git a/man/describe_distribution.Rd b/man/describe_distribution.Rd
diff --git a/man/extract_column_names.Rd b/man/extract_column_names.Rd
diff --git a/man/labels_to_levels.Rd b/man/labels_to_levels.Rd
diff --git a/man/means_by_group.Rd b/man/means_by_group.Rd
diff --git a/man/normalize.Rd b/man/normalize.Rd
diff --git a/man/ranktransform.Rd b/man/ranktransform.Rd
diff --git a/man/recode_values.Rd b/man/recode_values.Rd
diff --git a/man/rescale.Rd b/man/rescale.Rd