pharmaRTF Validation Report

Eli Miller

2025-06-30

Source: vignettes/Validate.Rmd

Validation Files Information

Specifications

Specification Name Last updated by Last updated date
specification.Rmd Ashley Tarasiewicz 2020-06-16

Test case

Test Case Name Last updated by Last updated date
test_cases.Rmd Ashley Tarasiewicz 2020-06-16

Test code

Test Code Name Last updated by Last updated date
test_cases.R Ashley Tarasiewicz 2020-06-16

Validation Results

Specifications

  • A: The RTF written out to a file can be opened in Microsoft Word
  • B: Paging of the table works appropriately
  • C: Changes to document level margins are reflected in the output document
  • D: Changes to document level header and footer height are reflected in the output document
  • E: Changes to document level page size are reflected in the output document
  • F: Changes to document level orientation are reflected in the output document
  • G: Changes to document level default font size are reflected in the output document
  • H: Changes to document level default font are reflected in the output document
  • I: Changes to document level header rows are reflected in the output document
  • J: Changes to document level column header buffer are reflected in the output document
  • K: Changes to document level ignore cell padding are reflected in the output document
  • L: Titles and footnotes can be manually entered in the RTF document creation
  • M: Titles and footnotes can be manually entered using add_titles/add_footnotes
  • N: Titles and footnotes can be manually entered importing from a separate file using a reader
  • O: PAGE_FORMAT for titles and footnotes works properly
  • P: DATE_FORMAT for titles and footnotes works properly
  • Q: FILE_PATH for titles and footnotes works properly
  • R: Bold titles/footnotes attributes update correctly when specified
  • S: Italic titles/footnotes attributes update correctly when specified
  • T: Align titles/footnotes attributes update correctly when specified, i.e. split titles/footnotes flush left and right as expected
  • U: Font titles/footnotes attributes update correctly when specified
  • V: Font size titles/footnotes attributes update correctly when specified
  • W: Index titles/footnotes attributes update correctly when specified, i.e. specified indices sort appropriately when entered in separte orders, NULL indices sort last
  • X: View functions (i.e. view_titles and view_footnotes) render data frames appropriately
  • Y: Updates to huxtable table bold table level property is properly formatted in the resulting RTF
  • Z: Updates to huxtable table italic table level property is properly formatted in the resulting RTF
  • AA: Updates to huxtable table alignment (center, left, right) table level property is properly formatted in the resulting RTF
  • AB: Updates to huxtable table vertical alignment (center, top, bottom) table level property is properly formatted in the resulting RTF
  • AC: Updates to huxtable table table width table level property is properly formatted in the resulting RTF
  • AD: Updates to huxtable table column width table level property is properly formatted in the resulting RTF
  • AE: Updates to huxtable table row height table level property is properly formatted in the resulting RTF
  • AF: Updates to huxtable table cell merging table level property is properly formatted in the resulting RTF
  • AG: When the header_rows attribute is 0, the column headers write to the RTF body instead of the document header

Matrix

Test Cases

This section contains details of each test executed. Checks verifying each test are included as sub-bullets of their associated test.

  • Setup: No prerequisites required

    • T1: Output an RTF using a dataframe requiring one page of output and verify output and paging are appropiate
      • T1.1: Verify document outputs as an RTF and opens in Word
      • T1.2: Verify output has column headers “Header1”, “Header2” above the table, a title “Title” at the top, and a footnote “Footnote” at the bottom
    • T2: Output an RTF using a dataframe requiring multiple pages of output and verify output and paging are appropiate
      • T2.1: Verify document outputs as an RTF and opens in Word
      • T2.2: Verify output has column headers “Header1”, “Header2” above the table, a title “Title” at the top, and a footnote “Footnote” at the bottom
      • T2.3: Verify output has the column headers, title, and footnote repeat on each page
    • T3: Check document level margins are set to the default value then change margins and verify changes are reflected in the output
      • T3.1: Verify document level margins are set to expected default: 1,1,1,1
      • T3.2: Verify document level margins on output are 2 (top), .5 (bottom), 1.5 (left), .25 (right)
    • T4: Check document level header and footer height are set to default then change header and footer height and verify changes are reflected in the output
      • T4.1: Verify document level header and footer heights are set to expected default: .5,.5
      • T4.2: Verify document level header and footer heights on output are .25 (header) and 1 (footer)
    • T5: Check document level page size is set to default then change page size and verify changes are reflected in the output
      • T5.1: Verify document level page size is set to expected default: 8.5 (height), 11 (width)
      • T5.2: Verify document level page size on output is 9 (height), 12 (width)
    • T6: Check document level orientation is set to default then change orientation and verify changes are reflected in the output
      • T6.1: Verify document level orientation is set to expected default: landscape
      • T6.2: Verify document level orientation on output is portrait
    • T7: Check document level font size is set to default then change font size and verify changes are reflected in the output
      • T7.1: Verify document level font size is set to expected default: 12
      • T7.2: Verify document level font size on output is 14
    • T8: Check document level font is set to default then change font and verify changes are reflected in the output
      • T8.1: Verify document level font is set to expected default: Courier New
      • T8.2: Verify document level font on output is Comic Sans
    • T9: Check document level header rows is set to default then change header rows and verify changes are reflected in the output
      • T9.1: Verify document level header rows is set to expected default: 1
      • T9.2: Verify document level header rows on output are 2 (rows starting with “Header1” and “1” are in the header)
    • T10: Check document level column header buffers is set to default then change column header buffers and verify changes are reflected in the output
      • T10.1: Verify document level column header buffers are set to expected default: 0,0
      • T10.2: Verify document level column header buffers on output are 2 (2 rows above header), 1 (1 row below header)
    • T11: Check document level ignore cell padding is set to default then change ignore cell padding and verify changes are reflected in the output
      • T11.1: Verify document level ignore cell padding is set to expected default: FALSE
      • T11.2: Verify document level ignore cell padding on output is TRUE (gap is closed between rows)
    • T12: Output an RTF with one title and one footnote created in the RTF document creation and verify the output
      • T12.1: Verify output has a title “rtf_doc Title 1” at the top, and a footnote “rtf_doc Footnote 1” at the bottom
    • T13: Output an RTF with multiple titles and multiple footnotes created in the RTF document creation and verify the output
      • T13.1: Verify output has titles “rtf_doc Title 1”, “rtf_doc Title 2”, “rtf_doc Title 3” at the top, and footnotes “rtf_doc Footnote 1”, “rtf_doc Footnote 2”, “rtf_doc Footnote 3” at the bottom
    • T14: Output an RTF with one title and one footnote using add_titles and add_footnotes and verify the output
      • T14.1: Verify output has a title “add_titles Title 1” at the top, and a footnote “add_footnotes Footnote 1” at the bottom
    • T15: Output an RTF with multiple titles and multiple footnotes using add_titles and add_footnotes and verify the output
      • T15.1: Verify output has titles “add_titles Title 1”, “add_titles Title 2”, “add_titles Title 3” at the top, and footnotes “add_footnotes Footnote 1”, “add_footnotes Footnote 2”, “add_footnotes Footnote 3” at the bottom
    • T16: Output an RTF with multiple titles and multiple footnotes created in the RTF document creation, then replace the titles and footnotes using add_titles and add_footnotes and verify the output
      • T16.1: Verify output has titles “add_titles Title 1”, “add_titles Title 2”, “add_titles Title 3” at the top, and footnotes “add_footnotes Footnote 1”, “add_footnotes Footnote 2”, “add_footnotes Footnote 3” at the bottom
    • T17: Output an RTF with multiple titles and multiple footnotes created in the RTF document creation, then append the titles and footnotes using add_titles and add_footnotes and verify the output
      • T17.1: Verify output has titles “rtf_doc Title 1”, “rtf_doc Title 2”, “rtf_doc Title 3”, “add_titles Title 1”, “add_titles Title 2”, “add_titles Title 3” at the top, and footnotes “rtf_doc Footnote 1”, “rtf_doc Footnote 2”, “rtf_doc Footnote 3”, “add_footnotes Footnote 1”, “add_footnotes Footnote 2”, “add_footnotes Footnote 3” at the bottom
    • T18: Output an RTF with titles and footnotes created by importing from a separate file using from.file of titles_and_footnotes_from_df and verify the output
      • T18.1: Verify output has titles “from.file Title 1”, “from.file Title 2”, “from.file Title 3” at the top, and footnotes “from.file Footnote 1”, “from.file Footnote 2”, “from.file Footnote 3” at the bottom
    • T19: Output an RTF with titles and footnotes created by importing from a separate file using from.df of titles_and_footnotes_from_df and verify the output
      • T19.1: Verify output has titles “from.df Title 1”, “from.df Title 2”, “from.df Title 3” at the top, and footnotes “from.df Footnote 1”, “from.df Footnote 2”, “from.df Footnote 3” at the bottom
    • T20: Output an RTF with titles and footnotes capturing PAGE_FORMAT DATE_FORMAT and FILE_PATH created in the RTF document creation and verify the output
      • T20.1: Verify output has titles “rtf_docPage <x> of <y>”, “rtf_doc<date>”, “rtf_docSource: <source>” at the top, and footnotes “rtf_docPage <x>”, “rtf_doc<date>”, “rtf_docSource: <source>” at the bottom
    • T21: Output an RTF with titles and footnotes capturing PAGE_FORMAT DATE_FORMAT and FILE_PATH using add_titles and add_footnotes and verify the output
      • T21.1: Verify output has titles “add_titlesPage <x> of <y>”, “add_titles<date>”, “add_titlesSource: <source>” at the top, and footnotes “add_footnotesPage <x>”, “add_footnotes<date>”, “add_footnotesSource: <source>” at the bottom
    • T22: Output an RTF with titles and footnotes capturing PAGE_FORMAT DATE_FORMAT and FILE_PATH created by importing from a separate file using a reader and verify the output
      • T22.1: Verify output has titles “externalPage <x> of <y>”, “external<date>”, “externalSource: <source>” at the top, and footnotes “externalPage <x>”, “external<date>”, “externalSource: <source>” at the bottom
    • T23: Check bold attribute of titles/footnotes created in the RTF document creation is set to default then change bold attribute and verify changes are reflected in the output
      • T23.1: Verify titles/footnotes bold is set to expected default: FALSE
      • T23.2: Verify output has bold titles “rtf_doc Title 1”, “rtf_doc Title 2”, non bold title “rtf_doc Title 3”, bold footnotes “rtf_doc Footnote 1”, “rtf_doc Footnote 3”, and non bold footnote “rtf_doc Footnote 2”
    • T24: Check bold attribute of titles/footnotes created using add_titles and add_footnotes is set to default then change bold attribute and verify changes are reflected in the output
      • T24.1: Verify titles/footnotes bold is set to expected default: FALSE
      • T24.2: Verify output has bold titles “add_titles Title 1”, “add_titles Title 2”, non bold title “add_titles Title 3”, bold footnotes “add_footnotes Footnote 1”, “add_footnotes Footnote 3”, and non bold footnote “add_footnotes Footnote 2”
    • T25: Check bold attribute of titles/footnotes created by importing from a separate file using a reader is set to default then change bold attribute and verify changes are reflected in the output
      • T25.1: Verify titles/footnotes bold is set to expected default: FALSE
      • T25.2: Verify output has bold titles “external Title 1”, “external Title 2”, non bold title “external Title 3”, bold footnotes “external Footnote 1”, “external Footnote 3”, and non bold footnote “external Footnote 2”
    • T26: Check italic attribute of titles/footnotes created in the RTF document creation is set to default then change italic attribute and verify changes are reflected in the output
      • T26.1: Verify titles/footnotes italic is set to expected default: FALSE
      • T26.2: Verify output has italic titles “rtf_doc Title 2”, “rtf_doc Title 3”, non italic title “rtf_doc Title 1”, italic footnote “rtf_doc Footnote 3”, and non italic footnotes “rtf_doc Footnote 1”, “rtf_doc Footnote 2”
    • T27: Check italic attribute of titles/footnotes created using add_titles and add_footnotes is set to default then change italic attribute and verify changes are reflected in the output
      • T27.1: Verify titles/footnotes italic is set to expected default: FALSE
      • T27.2: Verify output has italic titles “add_titles Title 2”, “add_titles Title 3”, non italic title “add_titles Title 1”, italic footnote “add_footnotes Footnote 3”, and non italic footnotes “add_footnotes Footnote 1”, “add_footnotes Footnote 2”
    • T28: Check italic attribute of titles/footnotes created by importing from a separate file using a reader is set to default then change italic attribute and verify changes are reflected in the output
      • T28.1: Verify titles/footnotes italic is set to expected default: FALSE
      • T28.2: Verify output has italic titles “external Title 2”, “external Title 3”, non italic title “external Title 1”, italic footnote “external Footnote 3”, and non italic footnotes “external Footnote 1”, “external Footnote 2”
    • T29: Check align attribute of titles/footnotes created in the RTF document creation is set to default then change align attribute and verify changes are reflected in the output
      • T29.1: Verify titles/footnotes align is set to expected default: center
      • T29.2: Verify output has left aligned title “rtf_doc Title 1”, right aligned title “rtf_doc Title 2”, center aligned title “rtf_doc Title 3”, left aligned footnotes “rtf_doc Footnote 1”, “rtf_doc Footnote 2”, and split footnote “rtf_doc Footnote 3 Part 1”, “rtf_doc Footnote 3 Part 2”
    • T30: Check align attribute of titles/footnotes created using add_titles and add_footnotes is set to default then change align attribute and verify changes are reflected in the output
      • T30.1: Verify titles/footnotes align is set to expected default: center
      • T30.2: Verify output has left aligned title “add_titles Title 1”, right aligned title “add_titles Title 2”, center aligned title “add_titles Title 3”, left aligned footnotes “add_footnotes Footnote 1”, “add_footnotes Footnote 2”, and split footnote “add_footnotes Footnote 3 Part 1”, “add_footnotes Footnote 3 Part 2”
    • T31: Check align attribute of titles/footnotes created by importing from a separate file using a reader is set to value specified in the file then change align attribute and verify changes are reflected in the output
      • T31.1: Verify titles/footnotes align is set to file value: center
      • T31.2: Verify output has left aligned title “external Title 1”, right aligned title “external Title 2”, center aligned title “external Title 3”, left aligned footnotes “external Footnote 1”, “external Footnote 2”, and split footnote “external Footnote 3 Part 1”, “external Footnote 3 Part 2”
    • T32: Check font attribute of titles/footnotes created in the RTF document creation is set to default then change font attribute and verify changes are reflected in the output
      • T32.1: Verify titles/footnotes font is set to expected default: NA
      • T32.2: Verify output has Comic Sans titles “rtf_doc Title 1”, “rtf_doc Title 2”, Courier New title “rtf_doc Title 3”, Comic Sans footnotes “rtf_doc Footnote 1”, “rtf_doc Footnote 3”, and Courier New footnote “rtf_doc Footnote 2”
    • T33: Check font attribute of titles/footnotes created using add_titles and add_footnotes is set to default then change font attribute and verify changes are reflected in the output
      • T33.1: Verify titles/footnotes font is set to expected default: NA
      • T33.2: Verify output has Comic Sans titles “add_titles Title 1”, “add_titles Title 2”, Courier New title “add_titles Title 3”, Comic Sans footnotes “add_footnotes Footnote 1”, “add_footnotes Footnote 3”, and Courier New footnote “add_footnotes Footnote 2”
    • T34: Check font attribute of titles/footnotes created by importing from a separate file using a reader is set to default then change font attribute and verify changes are reflected in the output
      • T34.1: Verify titles/footnotes font is set to expected default: NA
      • T34.2: Verify output has Comic Sans titles “external Title 1”, “external Title 2”, Courier New title “external Title 3”, Comic Sans footnotes “external Footnote 1”, “external Footnote 3”, and Courier New footnote “external Footnote 2”
    • T35: Check font size attribute of titles/footnotes created in the RTF document creation is set to default then change font size attribute and verify changes are reflected in the output
      • T35.1: Verify titles/footnotes font size is set to expected default: NA
      • T35.2: Verify output has size 12 title “rtf_doc Title 1”, size 14 title “rtf_doc Title 2”, size 10 title “rtf_doc Title 3”, size 30 footnote “rtf_doc Footnote 1”, and size 12 footnotes “rtf_doc Footnote 2”, “rtf_doc Footnote 3”
    • T36: Check font size attribute of titles/footnotes created using add_titles and add_footnotes is set to default then change font size attribute and verify changes are reflected in the output
      • T36.1: Verify titles/footnotes font size is set to expected default: NA
      • T36.2: Verify output has size 12 title “add_titles Title 1”, size 14 title “add_titles Title 2”, size 10 title “add_titles Title 3”, size 30 footnote “add_footnotes Footnote 1”, and size 12 footnotes “add_footnotes Footnote 2”, “add_footnotes Footnote 3”
    • T37: Check font size attribute of titles/footnotes created by importing from a separate file using a reader is set to default then change font size attribute and verify changes are reflected in the output
      • T37.1: Verify titles/footnotes font size is set to expected default: NA
      • T37.2: Verify output has size 12 title “external Title 1”, size 14 title “external Title 2”, size 10 title “external Title 3”, size 30 footnote “external Footnote 1”, and size 12 footnotes “external Footnote 2”, “external Footnote 3”
    • T38: Check index attribute of titles/footnotes created in the RTF document creation is set to default then change index attribute and verify changes are reflected in the output
      • T38.1: Verify titles/footnotes index is set to expected default: NA
      • T38.2: Verify output has titles in the order: “rtf_doc Title 3”, “rtf_doc Title 2”, “rtf_doc Title 1”, and footnotes in the order: “rtf_doc Footnote 2”, “rtf_doc Footnote 3”, “rtf_doc Footnote 1”
    • T39: Check index attribute of titles/footnotes created using add_titles and add_footnotes is set to default then change index attribute and verify changes are reflected in the output
      • T39.1: Verify titles/footnotes index is set to expected default: NA
      • T39.2: Verify output has titles in the order: “add_titles Title 3”, “add_titles Title 2”, “add_titles Title 1”, and footnotes in the order: “add_footnotes Footnote 2”, “add_footnotes Footnote 3”, “add_footnotes Footnote 1”
    • T40: Check index attribute of titles/footnotes created by importing from a separate file using a reader is set to default then change index attribute and verify changes are reflected in the output
      • T40.1: Verify titles/footnotes index is set to expected default: NA
      • T40.2: Verify output has titles in the order: “external Title 3”, “external Title 2”, “external Title 1”, and footnotes in the order: “external Footnote 2”, “external Footnote 3”, “external Footnote 1”
    • T41: Create titles in the RTF document creation, change attributes and verify changes are reflected in the view function dataframe
      • T41.1: Verify title is: bold=TRUE, italic=TRUE, align=right, font=Comic Sans, font size=13, index=4
    • T42: Create footnotes in the RTF document creation, change attributes and verify changes are reflected in the view function dataframe
      • T42.1: Verify footnote is: bold=TRUE, italic=TRUE, align=right, font=Comic Sans, font size=13, index=4
    • T43: Create titles using add_titles, change attributes and verify changes are reflected in the view function dataframe
      • T43.1: Verify title is: bold=TRUE, italic=TRUE, align=right, font=Comic Sans, font size=13, index=4
    • T44: Create footnotes using add_footnotes, change attributes and verify changes are reflected in the view function dataframe
      • T44.1: Verify footnote is: bold=TRUE, italic=TRUE, align=right, font=Comic Sans, font size=13, index=4
    • T45: Create titles by importing from a separate file using a reader, change attributes and verify changes are reflected in the view function dataframe
      • T45.1: Verify title is: bold=TRUE, italic=TRUE, align=right, font=Comic Sans, font size=13, index=4
    • T46: Create footnotes by importing from a separate file using a reader, change attributes and verify changes are reflected in the view function dataframe
      • T46.1: Verify footnote is: bold=TRUE, italic=TRUE, align=right, font=Comic Sans, font size=13, index=4
    • T47: Output an RTF using huxtable table bold table level property and verify output
      • T47.1: Verify output has bold text in the “Header1” column
    • T48: Output an RTF using huxtable table italic table level property and verify output
      • T48.1: Verify output has italic text in the “Header1” column
    • T49: Output an RTF using huxtable table alignment table level property and verify output
      • T49.1: Verify output has right aligned text in the “Header1” column
    • T50: Output an RTF using huxtable table row height and vertical alignment table level properties and verify output
      • T50.1: Verify huxtable table row heights are: .08 (rows 1-13) and .16 (row 14)
      • T50.2: Verify output has the row containing the text “13” roughly twice the height of the other rows
      • T50.3: Verify output has bottom aligned text in the “Header1” column
    • T51: Output an RTF using huxtable table width table level property and verify output
      • T51.1: Verify huxtable table width is 1.5
      • T51.2: Verify output has a table width roughly expanding the document
    • T52: Output an RTF using huxtable table column width table level property and verify output
      • T52.1: Verify huxtable table column widths are .4 (column 1) and .8 (column 2)
      • T52.2: Verify output has “Header2” column roughly twice the width of “Header1” column
    • T53: Output an RTF using huxtable table cell merging table level property and verify output
      • T53.1: Verify output has a merged cell for the first row that contains the text “1” and spans both the “Header1” and “Header2” columns
    • T54: Output an RTF with header_rows attribute = 0 and verify output
      • T54.1: Verify document level header rows on output are 0 (all rows are in the body)

Test Cases Results

System Information

R version 4.4.1 (2024-06-14) Platform: x86_64-pc-linux-gnu Running under: Ubuntu 22.04.5 LTS

Matrix products: default BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3 LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0

locale: [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
[3] LC_TIME=en_US.UTF-8 LC_COLLATE=en_US.UTF-8
[5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
[7] LC_PAPER=en_US.UTF-8 LC_NAME=C
[9] LC_ADDRESS=C LC_TELEPHONE=C
[11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C

time zone: Etc/UTC tzcode source: system (glibc)

attached base packages: [1] stats graphics grDevices utils datasets methods base

other attached packages: [1] readxl_1.4.5 lubridate_1.9.4 forcats_1.0.0 readr_2.1.5
[5] tidyr_1.3.1 tibble_3.3.0 ggplot2_3.5.2 tidyverse_2.0.0 [9] huxtable_5.6.0 pharmaRTF_0.1.4 purrr_1.0.4 stringr_1.5.1
[13] kableExtra_1.4.0 knitr_1.50 testthat_3.2.3 dplyr_1.1.4
[17] plyr_1.8.9

loaded via a namespace (and not attached): [1] sass_0.4.10 generics_0.1.4 xml2_1.3.8 stringi_1.8.7
[5] hms_1.1.3 digest_0.6.37 magrittr_2.0.3 grid_4.4.1
[9] evaluate_1.0.3 timechange_0.3.0 RColorBrewer_1.1-3 pkgload_1.4.0
[13] fastmap_1.2.0 cellranger_1.1.0 rprojroot_2.0.4 jsonlite_2.0.0
[17] brio_1.1.5 viridisLite_0.4.2 scales_1.4.0 textshaping_1.0.1 [21] jquerylib_0.1.4 cli_3.6.5 crayon_1.5.3 rlang_1.1.6
[25] withr_3.0.2 cachem_1.1.0 yaml_2.3.10 tools_4.4.1
[29] tzdb_0.5.0 assertthat_0.2.1 vctrs_0.6.5 R6_2.6.1
[33] lifecycle_1.0.4 fs_1.6.6 htmlwidgets_1.6.4 ragg_1.4.0
[37] waldo_0.6.1 pkgconfig_2.0.3 desc_1.4.3 gtable_0.3.6
[41] pkgdown_2.1.3 pillar_1.10.2 bslib_0.9.0 glue_1.8.0
[45] Rcpp_1.0.14 systemfonts_1.2.3 xfun_0.52 tidyselect_1.2.1
[49] rstudioapi_0.17.1 farver_2.1.2 htmltools_0.5.8.1 rmarkdown_2.29
[53] svglite_2.2.1 compiler_4.4.1

Manual Check Completion History