spelling

insightsengineering · Jan 30, 2024 · 65b09f2 · 65b09f2
1 parent 0fb2e5a
commit 65b09f2
Show file tree

Hide file tree

Showing 14 changed files with 96 additions and 89 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -8,29 +8,29 @@
 ## rtables 0.6.6
 ### New Features
  * Removed `ref_group` reordering in column splits so not to change the order.
- * Added `bold` argument to `as_html` to bold specified elements, and `header_sep_line` 
+ * Added `bold` argument to `as_html` to bold specified elements, and `header_sep_line`
    argument to print a horizontal line under the table header in rendered HTML output.
  * Duplicate referential footnotes are consolidated when tables are rendered.
  * Section divisors can be set for analysis rows.
  * Added setter and getter for section dividers (`section_div` and `section_div<-`). They also accept
    split section structure assignment.
- * Added `header_section_div` setters and getters for layout and table objects along with 
+ * Added `header_section_div` setters and getters for layout and table objects along with
    related `basic_table` parameter.
  * Added `na_str` argument to `analyze_colvars` to set custom string to print in place of missing values.
- * Added flat `data.frame` outputs for `as_result_df()` via flag parameters `as_viewer`, `as_strings`, and 
+ * Added flat `data.frame` outputs for `as_result_df()` via flag parameters `as_viewer`, `as_strings`, and
    `expand_colnames`.
- * Migrated `export_as_pdf` function to `formatters`. 
- 
+ * Migrated `export_as_pdf` function to `formatters`.
+
 ### Bug Fixes
  * Fixed a bug that was failing when wrapping and section dividers were used at the same time.
  * Fixed a bug in `as_result_df` causing misalignment of column names.
- * Fixed a bug that was not allowing path indexing as `row_paths()` was giving a different path due to it being made of 
+ * Fixed a bug that was not allowing path indexing as `row_paths()` was giving a different path due to it being made of
    named values.
  * Fixed a bug in `as_result_df` when called on tables with less than 3 rows.
 
 ### Miscellaneous
  * Applied `styler` and resolved package lint. Changed default indentation from 4 spaces to 2.
- * Added Developer Guide to pkgdown site with Debugging, Split Machinery, and Tabulation sections.
+ * Added Developer Guide with Debugging, Split Machinery, and Tabulation sections.
  * Whitespace is not trimmed when rendering tables with `as_html`.
  * Started deprecation cycle for `col_fnotes_here` to be replaced with `col_footnotes`.
  * Exported `section_div` methods now have a dedicated documentation page that is visible to users.
@@ -77,7 +77,7 @@
  * Removed superfluous warning which arose for custom split functions when reference group is is set (https://github.com/insightsengineering/rtables/issues/707#issuecomment-1678810598).
  * Fixed `qtable` labeling via `row_labels` ([#698](https://github.com/insightsengineering/rtables/issues/698)).
  * Error catching and test coverage for cases where `alt_counts_df` presents different splits from `df`.
- 
+
 ### Miscellaneous
  * Cleaned up spelling in documentation ([#685](https://github.com/insightsengineering/rtables/issues/685))
  * Custom appearance vignette updated with decimal alignment support.
@@ -94,16 +94,16 @@
 
 ## rtables 0.6.1
  * Improved resilience of pagination machinery (`paginate_table`) by generalizing parameters' defaults (`cpp`, `lpp`, and `font_size`).
- * Moved `export_as_txt` to `formatters`. Added to reexports. 
+ * Moved `export_as_txt` to `formatters`. Added to reexports.
  * Migrated `export_as_rtf` to `formatters`. Not re-exported.
  * add `r2rtf` to Suggests
  * pagination logic has been migrated completely (excepting page_by splits) to `formatters` and is now invoked from there. paginate_table remains as a convenience function.
- * Removed warning in `str` method when called upon table objects. 
- * Provide `str` method for `VTableTree` objects with a default `max.level` of 3, as the infinite default from base is not 
+ * Removed warning in `str` method when called upon table objects.
+ * Provide `str` method for `VTableTree` objects with a default `max.level` of 3, as the infinite default from base is not
    useful or informative.
  * default `font_size` value is now `8` across pagination and export machinery
  * `margins` argument in pagination and export machinery now (correctly) interpreted as inches. This change is inherited from `formatters`
- * `lpp` and `cpp` now default to `NA_integer_`, which is interpreted as inferring their value from the physical page size specified. 
+ * `lpp` and `cpp` now default to `NA_integer_`, which is interpreted as inferring their value from the physical page size specified.
  * Horizontal pagination now occurs by default due to the above (because there is a default page type - `"letter"`. Pagination can still be turned off in either direction by setting `l/cpp` to `NULL` explicitly.
  * Referential footnotes now have both a `symbol` and an `index`. Messages associated with symbols will only appear once per page in the footer materials regardless of number of elements referenced in the page with that symbol. Matches and inherits from changes in `formatters`
  * Started deprecation cycle for `trim_zero_rows`.
@@ -138,7 +138,7 @@
  * `export_to_txt` now automatically paginates when any form of page dimension is provided
    (previously the default was unconditionally not paginating).
  * Versioned dependency on `formatters` increased to `>=0.4.0`
- 
+
 ## rtables 0.5.3
  * `[<-` now treats character `i` and `j` values as paths, the same as `[` always has.
  * `[<-` `CellValue` method now preserves `CellValue` attributes (e.g., format)
@@ -153,7 +153,7 @@
  * export functions now accepts `tf_wrap` and `max_width` and use them in both pagination (when turned on) *and* `toString` when used (pdf, txt exporters).
  * versioned dependency on `formatters` increased to `>0.3.3.10`
  * `export_as_pdf` now accepts standard page/font size parameters
- * original parameters (`width`, `height`, `fontsize` are soft deprecated (no warning) and 
+ * original parameters (`width`, `height`, `fontsize` are soft deprecated (no warning) and
    will be fully deprecated and then removed in the future.
  * `toString` method for `VTableTree` now accepts `tf_wrap` and `max_width`
  * `export_as_txt` and `export_as_pdf` now accept `cpp`, as well as `tf_wrap` and `max_width` and
@@ -182,7 +182,7 @@
  * Updated versioned dependency on `formatters` to `>=0.3.2.3`
  * Equivalent split functions with different enclosing environments (e.g., 2 identical calls to `add_combo_levels` [#340](https://github.com/insightsengineering/rtables/issues/304)) no longer block `rbind`ing
  * Fixed various documentation bugs where description section was being added to header.
- 
+
 ## rtables 0.5.1.4
  * empty level check for splitting variables reinstated.
 
@@ -196,7 +196,7 @@
  * `col_counts` getter and setter now accept `path` argument.
  * empty levels of a splitting variable now result in an informative error message (character and factor cases).
  * fixed bug in handling of column extra arguments that was preventing `cbind`ing tables from working correctly ([#324]](https://github.com/insightsengineering/rtables/issues/324))
- 
+
 ## rtables 0.5.1
  * empty factor levels are now *not* dropped for column splits when ref_group is set ([#323](https://github.com/insightsengineering/rtables/issues/323))
  * `linesep` argument to `toString` and related functions renamed to `hsep`
@@ -205,15 +205,15 @@
  * New `hsep` argument to `build_table` which sets the horizontal separator for the constructed table (and subtables thereof)
  * New `horizontal_sep` and `horizontal_sep<-` accessors for constructed tables, the latter of which is mandatorily recursive.
  * `split_rows_by(var, child_labels="hidden")` no longer removes the structural subtable corresponding to levels of `var` ([#314](https://github.com/insightsengineering/rtables/issues/314))
- 
+
 ## rtables 0.5.0
  * `formatable` dependency renamed to `formatters` for suitability of release to CRAN
- * Update versioned dependency of `formatters` (previously `formatable`) to `>=0.2.0` 
- 
+ * Update versioned dependency of `formatters` (previously `formatable`) to `>=0.2.0`
+
 ## rtables 0.4.1.0004
  * Fix bug when function format combined with NULL `cfun` caused error ([#307](https://github.com/insightsengineering/rtables/issues/307))
  * Fix bug in `path_enriched_df` (which powers `tsv` export), related to ([#308](https://github.com/insightsengineering/rtables/issues/308))
- 
+
 ## rtables 0.4.1.0002
  * added `table_shell` to display shell of table with formats
 
@@ -231,14 +231,14 @@
  * new `tt_to_flextable` coercion function
  * new `export_as_pdf` exporter function
  * `value_at` and `cell_values` functions now have methods for `TableRow` objects making them usable in sorting/pruning functions
- 
+
 ## rtables 0.3.8.9001
  * new `trim_levels_to_map` split function based on `[@wwojciech](https://github.com/wwojciech)`'s work in [#203](https://github.com/insightsengineering/rtables/issues/203)
  * support for column referential footnotes
  * support for adding footnotes to existing table via `fnotes_at_path<-` function
  * `trim_levels_in_group` now trims empty levels of outer (split) variable by default
  * `value_at` and `cell_values` now work for `tablerow` objects
- * Fixed `as_html` bug in `multivar` split columns case 
+ * Fixed `as_html` bug in `multivar` split columns case
  * Fixed pagination off-by-one error
 
 
@@ -314,8 +314,8 @@ tables in the context of clinical trials.
 
 ## rtables 0.3.2.17.9041
 
-* Allow single variable to be used within `split_cols_by_multivar` 
-* Various removal of defunct 
+* Allow single variable to be used within `split_cols_by_multivar`
+* Various removal of defunct
 
 ## rtables 0.3.2.17.9040
 
@@ -361,7 +361,7 @@ tables in the context of clinical trials.
 
 ## rtables 0.3.2.17.9027
 
-* issues with no news: 
+* issues with no news:
 
 ## rtables 0.1.7
 
@@ -384,7 +384,7 @@ tables in the context of clinical trials.
 * `col_by` in `rtabulate` now accepts matrices:
   - `col_by_to_matrix`, `col_by_to_factor`, `by_factor_to_matrix`.
   - `by_add_total`, `by_all`, `by_combine`, `by_quartile`, `by_compare_subset`,  `by_hierarchical`, `by_drop_empty_cols`.
-  
+
 * New utility functions to deal with variable labels:
   - `label`, `var_labels<-`, `var_labels`, `var_labels_remove`, `var_relabel`, `with_label`.
 

diff --git a/R/tt_compatibility.R b/R/tt_compatibility.R
@@ -476,7 +476,7 @@ rbindl_rtables <- function(x, gap = 0, check_headers = TRUE) {
 #' @param \dots ANY. Elements to be stacked.
 #'
 #' @note
-#' When objects are rbinded, titles and footer information is retained from the first object (if any exists) if all
+#' When objects are row-binded, titles and footer information is retained from the first object (if any exists) if all
 #' other objects have no titles/footers or have identical titles/footers. Otherwise, all titles/footers are removed
 #' and must be set for the bound table via the [main_title()], [subtitles()], [main_footer()], and [prov_footer()]
 #' functions.

diff --git a/R/tt_export.R b/R/tt_export.R
@@ -75,7 +75,7 @@ formatters::export_as_txt
 #' Generate a Result Data Frame
 #'
 #' @description
-#' Collection of utilities to exctract `data.frame` from `TableTree` objects.
+#' Collection of utilities to extract `data.frame` from `TableTree` objects.
 #'
 #' @inheritParams gen_args
 #' @param spec character(1). The specification to use to

diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -1,5 +1,6 @@
 amongst
 Arg
+binded
 Carreras
 charset
 Chohan
@@ -12,7 +13,7 @@ dplyr
 emph
 facetted
 facetting
-flextable
+FFFL
 formatter
 getter
 getters
@@ -21,7 +22,9 @@ Heng
 ing
 initializer
 integerish
+iteratively
 Kelkhoff
+labelled
 Layouting
 layouting
 Lewandowski
@@ -34,6 +37,7 @@ orderable
 Paszty
 pathing
 Phuse
+postfix
 Postprocessing
 postprocessing
 Pre
@@ -56,6 +60,7 @@ Saibah
 sortable
 spl
 Stoilova
+STUDYID
 Subtable
 subtable
 subtable's
@@ -65,6 +70,8 @@ summarization
 tableone
 TableTree
 Tadeusz
+todo
+unaggregated
 unicode
 univariable
 unnested

diff --git a/man/data.frame_export.Rd b/man/data.frame_export.Rd
diff --git a/man/rbind.Rd b/man/rbind.Rd
diff --git a/vignettes/custom_appearance.Rmd b/vignettes/custom_appearance.Rmd
@@ -7,7 +7,7 @@ vignette: >
   %\VignetteIndexEntry{Customizing Appearance}
   %\VignetteEncoding{UTF-8}
   %\VignetteEngine{knitr::rmarkdown}
-editor_options: 
+editor_options:
   chunk_output_type: console
 ---
 
@@ -40,10 +40,10 @@ It is possible to align the content by assigning `"left"`, `"center"`
 `in_rows()` and `rcell()`, respectively. It is also possible to use `decimal`,
 `dec_right`, and `dec_left` for decimal alignments. The first takes all numerical
 values and aligns the decimal character `.` in every value of the column that has
-`align = "decimal"`. Also numberic without decimal values are aligned according to
+`align = "decimal"`. Also numeric without decimal values are aligned according to
 an imaginary `.` if specified as such. `dec_left` and `dec_right` behave similarly,
 with the difference that if the column present empty spaces at left or right, it
-pushes values towards left or right taking the one value that has most decimal 
+pushes values towards left or right taking the one value that has most decimal
 characters, if right, or non-decimal values if left. For more details, please read
 the related documentation page `help("decimal_align")`.
 
@@ -192,7 +192,7 @@ build_table(lyt, DM)
 
 Using the post-processing function:
 
-Without inset - 
+Without inset -
 ```{r}
 lyt <- basic_table() %>%
   analyze("AGE")
@@ -201,7 +201,7 @@ tbl <- build_table(lyt, DM)
 tbl
 ```
 
-With an inset of 5 characters - 
+With an inset of 5 characters -
 
 ```{r}
 table_inset(tbl) <- 5
@@ -234,7 +234,7 @@ result <- build_table(lyt, ex_adsl)
 result
 ```
 
-With inset - 
+With inset -
 
 Notice, the inset does not apply to any title materials
 (main title, subtitles, page titles), or provenance footer
@@ -353,7 +353,7 @@ basic_table(
   build_table(DM)
 ```
 
-Modified indent - 
+Modified indent -
 ```{r}
 basic_table(
   title = "Study XXXXXXXX",
@@ -417,7 +417,7 @@ Label order will mirror the order of `split_rows_by` calls. If the
 labels of any subgroups should be hidden, the `label_pos` argument
 should be set to hidden.
 
-"SEX" label position is hidden - 
+"SEX" label position is hidden -
 ```{r}
 basic_table(
   title = "Study XXXXXXXX",
@@ -432,7 +432,7 @@ basic_table(
   build_table(DM)
 ```
 
-"SEX" label position is with the top-left materials - 
+"SEX" label position is with the top-left materials -
 
 ```{r}
 basic_table(

diff --git a/vignettes/dev-guide/dg_debug_rtables.Rmd b/vignettes/dev-guide/dg_debug_rtables.Rmd
@@ -52,9 +52,9 @@ as you did recover.
 
 `<<-` for `recover` or `debugger` gives it to the global environment
 
-#### lo-fi debugging
+#### debugging techniques
 
-* PRINT / CAT is always a low level debugging that can be used. It is helpful for server jobs where maybe only terminal or console output is available and no `browser()` can be used. For example, you can print the position or state of a function at a certain point untill you find the break point.
+* PRINT / CAT is always a low level debugging that can be used. It is helpful for server jobs where maybe only terminal or console output is available and no `browser()` can be used. For example, you can print the position or state of a function at a certain point until you find the break point.
 * comment blocks -> does not work with pipes (you can use `identity()` it is a step that does nothing but does not break the pipes)
 * `browser()` bombing