Skip to content

Commit

Permalink
fixing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Melkiades committed Jun 7, 2024
1 parent 22b3e8e commit b6a70ba
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 30 deletions.
4 changes: 2 additions & 2 deletions R/argument_conventions.R
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ gen_args <- function(df, alt_counts_df, spl, pos, tt, tr, verbose, colwidths, ob
#' uniqueness.
#' @param vars (`character`)\cr vector of variable names.
#' @param var_labels (`character`)\cr vector of labels for one or more variables.
#' @param show_colcounts (`logical(1)`)\cr Should column counts be displayed at the level
#' @param show_colcounts (`logical(1)`)\cr should column counts be displayed at the level
#' facets created by this split. Defaults to `FALSE`.
#' @param colcount_format (`character(1)`)\cr If `show_colcounts` is `TRUE`, the
#' @param colcount_format (`character(1)`)\cr if `show_colcounts` is `TRUE`, the
#' format which should be used to display column counts for facets generated by
#' this split. Defaults to `"(N=xx)"`.
#'
Expand Down
13 changes: 7 additions & 6 deletions R/tree_accessors.R
Original file line number Diff line number Diff line change
Expand Up @@ -2032,7 +2032,7 @@ setMethod(

#' @rdname col_accessors
#' @param ccount_format (`FormatSpec`)\cr The format to be used by default for column
#' counts throughout this column tree (ie if not overridden by a more specific format
#' counts throughout this column tree (i.e. if not overridden by a more specific format
#' specification).
#' @export
setGeneric(
Expand Down Expand Up @@ -2558,11 +2558,12 @@ ct_recursive_replace <- function(ctree, path, value, pos = 1) {
#' Set visibility of column counts for a group of sibling facets
#'
#' @inheritParams gen_args
#' @param path character. The path *to the parent of the
#' desired siblings*. The last element in the path should
#' be a split name.
#' @return obj, modified with the desired columncount
#' display behavior
#' @param path (`character`)\cr the path *to the parent of the
#' desired siblings*. The last element in the path should
#' be a split name.
#' @return obj, modified with the desired column count.
#' display behavior
#'
#' @export
`facet_colcounts_visible<-` <- function(obj, path, value) {
coldf <- make_col_df(obj, visible_only = FALSE)
Expand Down
2 changes: 1 addition & 1 deletion R/tt_showmethods.R
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ setMethod(
)


#' Display columntree structure
#' Display column tree structure
#'
#' Displays the tree structure of the columns of a
#' table or column structure object.
Expand Down
3 changes: 0 additions & 3 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ ValueWrapper
Yung
amongst
charset
columncount
columntree
combinatorial
customizations
de
Expand All @@ -50,7 +48,6 @@ formatters
funder
getter
getters
ie
ing
initializer
iteratively
Expand Down
4 changes: 2 additions & 2 deletions man/MultiVarSplit.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/VarLevelSplit.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/col_accessors.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/coltree_structure.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/cutsplits.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/facet_colcounts_visible-set.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/lyt_args.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/split_cols_by.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/split_cols_by_multivar.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/varcuts.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b6a70ba

Please sign in to comment.