Class that defines the Replace Outputs
ReplaceOutputs.RdThis R6 class allows to, given a template word document and a list of outputs, to add them at the given location in the text. It automates the time-consuming task of adding and formatting tables and figures to a word document. The two main inputs of the class are a template docx file, in this case a clinical trial report and a yaml file that will contain the names of the table/figures to be replaced and pointing to the new ones. The yml file, should have predefined structure and parameters to be set:
type. Indicates if it is a table (TBL) or a figure (FIG)
title. The title or caption of the table/figure in the template docx file
file. The name of the file (csv or image) to be used in the new version of the docx
widths. For tables only, a pre-defined column widths (useful for model parameter table, for example)
occurrence. Int. To be used when captions are duplicated for more than one figure/table. To set the order they appear in the word document.
An example of the yaml structure:
output_1:
type: TBL
title: "Caption of the output 1"
file: output_1.csv
widths: ~
occurrence: ~
output_2:
type: FIG
title: "Caption of the output 2"
file: output_2.png
Active bindings
template_docx_filenameActive binding for setting the path to the template docx
outputs_pathActive binding for setting the path to the folder with the outputs
doc_final_filenameActive binding for setting the path for the updated docx file
yml_filenameActive binding for setting the path to the yaml file
Methods
Method new()
Usage
ReplaceOutputs$new(
template_docx_filename = NA_character_,
outputs_path = NA_character_,
doc_final_filename = NA_character_,
yml_filename = NA_character_
)Arguments
template_docx_filenameString. File name of the template docx to be modified. For example, "/path/to/file/filename.docx"
outputs_pathString. Path to the folder with the outputs (figures and tables-csvs) that will be added to the new version of the docx
doc_final_filenameString. File name of the updated version of the docx file. For example, "/path/to/file/filename_updated.docx"
yml_filenameString. File name of the yaml file that will guide the replacement of the outputs (tables and figures) in the updated docx. For example, "/path/to/file/filename.yml"
Examples
uo <- ReplaceOutputs$new(
template_docx_filename = system.file("use_cases/02_automated_reporting",
"Automated_Reporting_Example.docx",
package="rdocx"),
outputs_path = system.file("use_cases/02_automated_reporting/example_outputs",
package="rdocx"),
doc_final_filename = "./test.docx",
yml_filename = system.file("use_cases/02_automated_reporting",
"example_yml_1.yml",
package="rdocx")
)
Method get_captions_to_yml()
Get captions to yaml Given a docx file, it scans the document to find the Figures and Tables captions and provides a yaml file with all the figures and tables found. It also scans the document for possible "Source:" which has to be after a placeholder figure/table. If source was found, it will be added to "file" param in the yaml file.
Arguments
yml_caption_filenameString. File name of the newly created yaml file that will contain the Figures and Tables of in the provided docx document. For example, "/path/to/file/filename.yml" It will follow the required format for the replacement of the outputs (tables and figures) to update docx.
output_1: type: TBL title: "Caption of the output 1" file: ~ widths: ~ occurrence: ~ output_2: type: FIG title: "Caption of the output 2" file: ~ widths: ~ occurrence: ~
Examples
uo <- ReplaceOutputs$new(
template_docx_filename = system.file("use_cases/02_automated_reporting",
"Automated_Reporting_Example.docx",
package="rdocx"),
outputs_path = system.file("use_cases/02_automated_reporting/example_outputs",
package="rdocx"),
doc_final_filename = "./test.docx"
)
uo$get_captions_to_yml(yml_caption_filename="./test_yml.yml")
Method update_all_outputs()
Update all outputs. It iterates through all the outputs in the yml file, and assigns them in the correct location in the updated docx. If no "file" param given (NA or NULL), it will skip the output.
Examples
uo <- ReplaceOutputs$new(
template_docx_filename = system.file("use_cases/02_automated_reporting",
"Automated_Reporting_Example.docx",
package="rdocx"),
outputs_path = system.file("use_cases/02_automated_reporting/example_outputs",
package="rdocx"),
doc_final_filename = "./test.docx",
yml_filename = system.file("use_cases/02_automated_reporting",
"example_yml_1.yml",
package="rdocx")
)
uo$update_all_outputs()Examples
## ------------------------------------------------
## Method `ReplaceOutputs$new`
## ------------------------------------------------
uo <- ReplaceOutputs$new(
template_docx_filename = system.file("use_cases/02_automated_reporting",
"Automated_Reporting_Example.docx",
package="rdocx"),
outputs_path = system.file("use_cases/02_automated_reporting/example_outputs",
package="rdocx"),
doc_final_filename = "./test.docx",
yml_filename = system.file("use_cases/02_automated_reporting",
"example_yml_1.yml",
package="rdocx")
)
## ------------------------------------------------
## Method `ReplaceOutputs$get_captions_to_yml`
## ------------------------------------------------
uo <- ReplaceOutputs$new(
template_docx_filename = system.file("use_cases/02_automated_reporting",
"Automated_Reporting_Example.docx",
package="rdocx"),
outputs_path = system.file("use_cases/02_automated_reporting/example_outputs",
package="rdocx"),
doc_final_filename = "./test.docx"
)
uo$get_captions_to_yml(yml_caption_filename="./test_yml.yml")
## ------------------------------------------------
## Method `ReplaceOutputs$update_all_outputs`
## ------------------------------------------------
uo <- ReplaceOutputs$new(
template_docx_filename = system.file("use_cases/02_automated_reporting",
"Automated_Reporting_Example.docx",
package="rdocx"),
outputs_path = system.file("use_cases/02_automated_reporting/example_outputs",
package="rdocx"),
doc_final_filename = "./test.docx",
yml_filename = system.file("use_cases/02_automated_reporting",
"example_yml_1.yml",
package="rdocx")
)
uo$update_all_outputs()
#> INFO [17:02:08.432] Word template filename: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/Automated_Reporting_Example.docx
#> INFO [17:02:08.462] Outputs path: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs
#> INFO [17:02:08.469] Yml filename: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_yml_1.yml
#> INFO [17:02:08.470] Final doc filename: ./test.docx
#> INFO [17:02:08.471] Date and time: 2024-11-15 17:02:08.470725 UTC
#> INFO [17:02:08.472] DaVinci user: runner
#> INFO [17:02:08.472] ****************************************************************
#> INFO [17:02:08.513] Output: FIG Data Point Distribution in Sample Set A
#> INFO [17:02:08.751] Figure updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Figure_2_1_Data_Point_Distribution.png
#> INFO [17:02:08.752] Output: FIG Comparative Analysis of Categories X and Y
#> INFO [17:02:08.946] Figure updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Figure_2_2_Comparative_Analysis.png
#> INFO [17:02:08.948] Output: FIG Comparative Analysis of Categories X and Y
#> INFO [17:02:09.142] Figure updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Figure_2_3_Comparative_Analysis.png
#> INFO [17:02:09.143] Output: FIG Trend Analysis Over Time (Yearly Data)
#> INFO [17:02:09.336] Figure updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Figure_2_4_Trend_Analysis.png
#> INFO [17:02:09.337] Output: FIG Trend Analysis Over Time (Yearly Data)
#> INFO [17:02:09.528] Figure updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Figure_2_5_Trend_Analysis.png
#> INFO [17:02:09.529] Output: FIG Trend Analysis Over Time (Monthly Data)
#> INFO [17:02:09.719] Figure updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Figure_3_1_Trend_Analysis.png
#> INFO [17:02:09.720] Output: TBL Summary of Sample Statistics
#> INFO [17:02:09.820] Table updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Table_2_1_Sample_Statistics.csv
#> INFO [17:02:09.821] Output: TBL Breakdown of Category X by Subcategory
#> INFO [17:02:09.924] Table updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Table_2_2_Breakdown_of_Category_X.csv
#> INFO [17:02:09.926] Output: TBL Yearly Performance Metrics
#> INFO [17:02:10.041] Table updated with: /home/runner/work/_temp/Library/rdocx/use_cases/02_automated_reporting/example_outputs/Table_3_1_Yearly_Performance_Metrics.csv
#> INFO [17:02:10.200] Docx saved!! File located at: ./test.docx
#> INFO [17:02:10.201] ****************************************************************
#> INFO [17:02:10.202] Information about this R session
#> INFO [17:02:10.203] [1] "/home/runner/work/_temp/Library" "/opt/R/4.4.2/lib/R/site-library"
#> INFO [17:02:10.203] [3] "/opt/R/4.4.2/lib/R/library"
#> INFO [17:02:10.204] ****************************************************************
#> INFO [17:02:10.217] R version 4.4.2 (2024-10-31)
#> INFO [17:02:10.217] Platform: x86_64-pc-linux-gnu
#> INFO [17:02:10.217] Running under: Ubuntu 22.04.5 LTS
#> INFO [17:02:10.217]
#> INFO [17:02:10.217] Matrix products: default
#> INFO [17:02:10.217] BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
#> INFO [17:02:10.217] LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0
#> INFO [17:02:10.217]
#> INFO [17:02:10.217] locale:
#> INFO [17:02:10.217] [1] LC_CTYPE=C.UTF-8 LC_NUMERIC=C LC_TIME=C.UTF-8
#> INFO [17:02:10.217] [4] LC_COLLATE=C LC_MONETARY=C.UTF-8 LC_MESSAGES=C.UTF-8
#> INFO [17:02:10.217] [7] LC_PAPER=C.UTF-8 LC_NAME=C LC_ADDRESS=C
#> INFO [17:02:10.217] [10] LC_TELEPHONE=C LC_MEASUREMENT=C.UTF-8 LC_IDENTIFICATION=C
#> INFO [17:02:10.217]
#> INFO [17:02:10.217] time zone: UTC
#> INFO [17:02:10.217] tzcode source: system (glibc)
#> INFO [17:02:10.217]
#> INFO [17:02:10.217] attached base packages:
#> INFO [17:02:10.217] [1] stats graphics grDevices utils datasets methods base
#> INFO [17:02:10.217]
#> INFO [17:02:10.217] other attached packages:
#> INFO [17:02:10.217] [1] rdocx_1.0.0
#> INFO [17:02:10.217]
#> INFO [17:02:10.217] loaded via a namespace (and not attached):
#> INFO [17:02:10.217] [1] xfun_0.49 bslib_0.8.0 httr2_1.0.6
#> INFO [17:02:10.217] [4] vctrs_0.6.5 tools_4.4.2 generics_0.1.3
#> INFO [17:02:10.217] [7] curl_6.0.1 tibble_3.2.1 fansi_1.0.6
#> INFO [17:02:10.217] [10] pkgconfig_2.0.3 data.table_1.16.2 checkmate_2.3.2
#> INFO [17:02:10.217] [13] desc_1.4.3 uuid_1.2-1 lifecycle_1.0.4
#> INFO [17:02:10.217] [16] flextable_0.9.7 compiler_4.4.2 stringr_1.5.1
#> INFO [17:02:10.217] [19] textshaping_0.4.0 brio_1.1.5 fontawesome_0.5.2
#> INFO [17:02:10.217] [22] fontquiver_0.2.1 fontLiberation_0.1.0 htmltools_0.5.8.1
#> INFO [17:02:10.217] [25] sass_0.4.9 yaml_2.3.10 pillar_1.9.0
#> INFO [17:02:10.217] [28] pkgdown_2.1.1 crayon_1.5.3 jquerylib_0.1.4
#> INFO [17:02:10.217] [31] whisker_0.4.1 openssl_2.2.2 cachem_1.1.0
#> INFO [17:02:10.217] [34] magick_2.8.5 fontBitstreamVera_0.1.1 tidyselect_1.2.1
#> INFO [17:02:10.217] [37] zip_2.3.1 digest_0.6.37 stringi_1.8.4
#> INFO [17:02:10.217] [40] dplyr_1.1.4 purrr_1.0.2 fastmap_1.2.0
#> INFO [17:02:10.217] [43] grid_4.4.2 cli_3.6.3 magrittr_2.0.3
#> INFO [17:02:10.217] [46] utf8_1.2.4 withr_3.0.2 gdtools_0.4.1
#> INFO [17:02:10.217] [49] backports_1.5.0 rappdirs_0.3.3 rmarkdown_2.29
#> INFO [17:02:10.217] [52] officer_0.6.7 jpeg_0.1-10 askpass_1.2.1
#> INFO [17:02:10.217] [55] ragg_1.3.3 png_0.1-8 memoise_2.0.1
#> INFO [17:02:10.217] [58] evaluate_1.0.1 knitr_1.49 testthat_3.2.1.1
#> INFO [17:02:10.217] [61] rlang_1.1.4 downlit_0.4.4 Rcpp_1.0.13-1
#> INFO [17:02:10.217] [64] glue_1.8.0 xml2_1.3.6 rstudioapi_0.17.1
#> INFO [17:02:10.217] [67] jsonlite_1.8.9 lgr_0.4.4 R6_2.5.1
#> INFO [17:02:10.217] [70] systemfonts_1.1.0 fs_1.6.5