Merge pull request #269 from Merck/feature/issue-235-text-hyphenation

Feature/issue 235 text hyphenation

Author: wangben718

CLAUDE.md

@@ -0,0 +1,79 @@
+# Project Context for r2rtf
+
+## Overview
+This is an R package for generating RTF (Rich Text Format) tables, figures, and listings. As a senior data scientist maintaining this package, I should be familiar with RTF syntax and R package development best practices.
+
+## Key Information
+- **Package Purpose**: Generate RTF tables, figures, and listings programmatically in R
+- **Domain**: Clinical trial reporting and data visualization
+- **RTF Expertise**: Understanding of RTF syntax and specification is essential
+- **R Version**: 4.5.1 on macOS (aarch64-apple-darwin24.4.0)
+
+## Development Guidelines
+- Follow R package development best practices
+- Maintain backward compatibility when possible
+- Ensure RTF output conforms to specification
+- Test thoroughly with various table/figure configurations
+- Always run tests before committing changes
+
+## Development Workflow Commands (using devtools)
+- Load package for development: `devtools::load_all()`
+- Run all tests: `devtools::test()`
+- Run specific tests: `devtools::test(filter = "rtf_title")`
+- Build package: `devtools::build()`
+- Check package: `devtools::check()`
+- Generate/update documentation: `devtools::document()` or `roxygen2::roxygenise()`
+- Install package locally: `devtools::install()`
+- Build pkgdown site: `pkgdown::build_site()` or `devtools::build_site()`
+- Build reference only: `pkgdown::build_reference()`
+- Build articles only: `pkgdown::build_articles()`
+
+## System Dependencies (macOS with Homebrew)
+Required system libraries for development:
+- `libgit2` - for gert package
+- `harfbuzz`, `fribidi` - for textshaping package
+- `freetype`, `libpng`, `libtiff`, `libjpeg-turbo` - for ragg package
+- `pkg-config` - for package configuration
+- `pandoc` - for building documentation and vignettes
+
+Install with: `brew install libgit2 harfbuzz fribidi freetype libpng libtiff libjpeg-turbo pkg-config pandoc`
+
+## Package Installation
+For better dependency management, use `pak`:
+```r
+# Install pak if not available
+install.packages("pak", repos = "https://r-lib.github.io/p/pak/stable/")
+
+# Install development tools
+pak::pkg_install(c("devtools", "tidyverse", "testthat", "roxygen2", "pkgdown", "emmeans"))
+```
+
+## Key Functions Being Maintained
+- `rtf_title()` - Add title attributes to tables
+- `rtf_colheader()` - Add column header attributes to tables
+- `rtf_subline()` - Add subline attributes to tables
+- `rtf_body()` - Format table body
+- `rtf_footnote()` - Add footnotes to tables
+- `rtf_source()` - Add source information to tables
+- `rtf_page()` - Set page attributes
+
+## Recent Changes
+- **Issue #235**: Added `text_hyphenation` parameter to `rtf_title()`, `rtf_colheader()`, and `rtf_subline()` functions
+  - Default value is `TRUE` for backward compatibility
+  - Allows users to control text hyphenation in RTF output
+  - Branch: `feature/issue-235-text-hyphenation`
+
+## Important Files
+- DESCRIPTION: Package metadata
+- NAMESPACE: Exported functions
+- R/: Source code
+- tests/testthat/: Unit tests
+- man/: Documentation (auto-generated by roxygen2)
+- vignettes/: Package vignettes
+- inst/: Additional package files
+
+## Testing Approach
+- Unit tests using `testthat` framework
+- Test files named `test-independent-testing-*.R`
+- Snapshot tests for complex output validation
+- Always verify changes don't break existing functionality

R/rtf_colheader.R

@@ -22,6 +22,7 @@
 #' Default is NULL for a blank column header.
 #' @param col_rel_width A Column relative width in a vector e.g. c(2,1,1) refers to 2:1:1.
 #'                      Default is NULL for equal column width.
+#' @param text_hyphenation A logical value to control whether display text linked with hyphenation.
 #' @inheritParams rtf_footnote
 #'
 #' @section Specification:
@@ -77,6 +78,7 @@ rtf_colheader <- function(tbl,
                           text_space = 1,
                           text_space_before = 15,
                           text_space_after = 15,
+                          text_hyphenation = TRUE,
                           text_convert = TRUE) {
   # Check argument type
   check_args(tbl, type = c("data.frame"))
@@ -118,7 +120,7 @@ rtf_colheader <- function(tbl,
     text_space_before,
     text_space_after,
     text_new_page = FALSE,
-    text_hyphenation = TRUE,
+    text_hyphenation = text_hyphenation,
     text_convert = text_convert
   )
   if (attr(colheader, "use_color")) attr(tbl, "page")$use_color <- TRUE

R/rtf_title.R

@@ -23,6 +23,7 @@
 #' @param tbl A data frame.
 #' @param title Title in a character string.
 #' @param subtitle Subtitle in a character string.
+#' @param text_hyphenation A logical value to control whether display text linked with hyphenation.
 #' @inheritParams rtf_footnote
 #'
 #' @section Specification:
@@ -61,6 +62,7 @@ rtf_title <- function(tbl,
                       text_space = 1,
                       text_space_before = 180,
                       text_space_after = 180,
+                      text_hyphenation = TRUE,
                       text_convert = TRUE) {
   # check argument types
   check_args(title, type = c("character"))
@@ -99,7 +101,7 @@ rtf_title <- function(tbl,
     text_space_before,
     text_space_after,
     text_new_page = FALSE,
-    text_hyphenation = TRUE,
+    text_hyphenation = text_hyphenation,
     text_convert = text_convert
   )
 
@@ -119,6 +121,7 @@ rtf_title <- function(tbl,
 #'
 #' @param tbl A data frame.
 #' @param text A character vector of subline
+#' @param text_hyphenation A logical value to control whether display text linked with hyphenation.
 #' @inheritParams rtf_footnote
 #'
 #' @section Specification:
@@ -148,6 +151,7 @@ rtf_subline <- function(tbl,
                         text_space = 1,
                         text_space_before = 180,
                         text_space_after = 180,
+                        text_hyphenation = TRUE,
                         text_convert = TRUE) {
   # Input checking
   check_args(text, type = c("character"))
@@ -182,7 +186,7 @@ rtf_subline <- function(tbl,
     text_space_before,
     text_space_after,
     text_new_page = FALSE,
-    text_hyphenation = TRUE,
+    text_hyphenation = text_hyphenation,
     text_convert = text_convert
   )
 

man/rtf_colheader.Rd

@@ -49,6 +49,20 @@ test_that("border type", {
   expect_equal(attr(attr(x, "rtf_colheader")[[2]], "border_left")[1, ], c("double", "single", "dot dot"))
 })
 
+test_that("text hyphenation parameter", {
+  # Test default value (TRUE)
+  x <- r2rtf_tbl1 |> rtf_colheader(colheader = "Column 1 | Column 2 | Column 3")
+  expect_equal(attr(attr(x, "rtf_colheader")[[1]], "text_hyphenation"), TRUE)
+
+  # Test explicitly setting to FALSE
+  x <- r2rtf_tbl1 |> rtf_colheader(colheader = "Column 1 | Column 2 | Column 3", text_hyphenation = FALSE)
+  expect_equal(attr(attr(x, "rtf_colheader")[[1]], "text_hyphenation"), FALSE)
+
+  # Test explicitly setting to TRUE
+  x <- r2rtf_tbl1 |> rtf_colheader(colheader = "Column 1 | Column 2 | Column 3", text_hyphenation = TRUE)
+  expect_equal(attr(attr(x, "rtf_colheader")[[1]], "text_hyphenation"), TRUE)
+})
+
 
 test_that("cell text formats", {
   x <- r2rtf_tbl1 |>

man/rtf_subline.Rd

@@ -60,3 +60,24 @@ test_that("multiple subtitles", {
   expect_equal(attributes(x)$rtf_title[[2]], "Sub-Title 2")
   expect_equal(attributes(x)$rtf_title[[3]], "Sub-Title 3")
 })
+
+test_that("text hyphenation parameter", {
+  # Test default value (TRUE)
+  x <- r2rtf_tbl1 |> rtf_title(title = "Title with Hyphenation")
+  expect_equal(attr(attr(x, "rtf_title"), "text_hyphenation"), TRUE)
+
+  # Test explicitly setting to FALSE
+  x <- r2rtf_tbl1 |> rtf_title(title = "Title without Hyphenation", text_hyphenation = FALSE)
+  expect_equal(attr(attr(x, "rtf_title"), "text_hyphenation"), FALSE)
+
+  # Test explicitly setting to TRUE
+  x <- r2rtf_tbl1 |> rtf_title(title = "Title with Hyphenation", text_hyphenation = TRUE)
+  expect_equal(attr(attr(x, "rtf_title"), "text_hyphenation"), TRUE)
+
+  # Test with rtf_subline
+  x <- r2rtf_tbl1 |> rtf_subline(text = "Subline with default hyphenation")
+  expect_equal(attr(attr(x, "rtf_subline"), "text_hyphenation"), TRUE)
+
+  x <- r2rtf_tbl1 |> rtf_subline(text = "Subline without hyphenation", text_hyphenation = FALSE)
+  expect_equal(attr(attr(x, "rtf_subline"), "text_hyphenation"), FALSE)
+})