Merge pull request #159 from Merck/news-and-version

Update news and bump version for 1.0.2

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: r2rtf
 Title: Easily Create Production-Ready Rich Text Format (RTF) Table and Figure
-Version: 1.0.1
+Version: 1.0.2
 Authors@R: c(
     person("Yilong", "Zhang", email = "elong0527@gmail.com", role = c("aut", "cre")),
     person("Siruo", "Wang", role = "aut"),
@@ -40,13 +40,13 @@ Suggests:
     emmeans,
     ggplot2,
     knitr,
+    magrittr,
     officer,
-    xml2,
     rmarkdown,
     stringi,
     testthat,
     tidyr,
-    magrittr
+    xml2
 Config/testthat/edition: 3
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3

NEWS.md

@@ -1,83 +1,149 @@
+# r2rtf 1.0.2 (2023-04-28)
+
+## Bug fixes
+
+* Display proper indentation for footnote and data source (#141).
+* Fix an issue when a column only contains missing value (#146).
+
+## Improvements
+
+* Improve grammar and style for the main vignette (@howardbaek, #144).
+* Add libreoffice 7.4 and 7.5 support (#156).
+* Add citation details (#155).
+
 # r2rtf 1.0.1 (2023-02-02)
 
-* New feature: enable vertical alignment (#136)
-* bug fix: enable libreoffice7.3 (#92)
+## New features
+
+* Enable vertical alignment (#136).
+
+## Improvements
+
+* Add support for libreoffice 7.3 (#92).
 
 # r2rtf 1.0.0 (2023-01-12)
 
-* New functions: `assemble_docx` and `assemble_rtf`.
-* Update copyright 
-* bug fix: rtf_enode fails when data contains NA and fixed-width font is used (#118)
-* bug fix: avoid error when `cell_nrow=1` (#108, #109)
+## New features
+
+* Add new functions: `assemble_docx()` and `assemble_rtf()`.
+
+## Bug fixes
+
+* `rtf_encode()` fails when data contains `NA` and fixed-width font is used (#118).
+* Avoid error when `cell_nrow = 1` (#108, #109).
+
+## Improvements
+
+* Update copyright text.
 
 # r2rtf 0.3.5 (2022-05-17)
 
-* bug fix: avoid warning message for matrix dimission in R4.2.0 (#101)
-* bug fix: vectorized text justification for `r2rtf::rtf_title`, `r2rtf::rtf_footnote`, etc (#98)
+## Bug fixes
+
+* Avoid warning messages on matrix dimension in R >= 4.2.0 (#101).
+* Vectorized text justification for `rtf_title()`, `rtf_footnote()`, and other functions (#98).
 
 # r2rtf 0.3.4 (2022-04-08)
 
-* Update maintainer email 
-* bug fix: utf8Tortf provide additional "-"
+## Bug fixes
+
+* `utf8Tortf()` provides additional "-".
+
+## Improvements
+
+* Update maintainer email.
 
 # r2rtf 0.3.3 (2022-03-07)
 
-* New argument: add `use_color` argument in `rtf_page`
-* bug fix: convert to proper RTF code
-* bug fig:` rft_encode()` doesn't add footnote and source to all pages for `doc_type = "figure"` (#90)
+## Improvements
+
+* `rtf_page()` now has a new argument `use_color`.
+
+## Bug fixes
+
+* Convert to proper RTF code.
+* `rft_encode()` does not add footnote and source to all pages for `doc_type = "figure"` (#90).
 
 # r2rtf 0.3.2 (2021-12-07)
 
-* New function: `rtf_read_figure` support `jpeg` and `emf` format to read figure (#65)
-* Improvement: avoid specific libreoffice version (#68)
-* Bug fix: avoid using `as.vector` for `data.frame` (#74)
-* Bug fix: proper alignment to transfer `html` (#61)
+## New features
+
+* The new function `rtf_read_figure()` supports `jpeg` and `emf` formats for reading figures (#65).
+
+## Bug fixes
+
+* Avoid using `as.vector` for `data.frame` (#74).
+* Proper alignment to transfer `html` (#61).
+
+## Improvements
+
+* Avoid specific libreoffice version (#68).
 
 # r2rtf 0.3.1 (2021-09-09)
 
-* New argument `cell_vertical_alignment` in `rtf_xxx` function. (#49, #52)
-* New argument `verbose` in `rtf_encode_list` and `rtf_encode_table`. (#38)
-* Bug fix `unicode_latex` not found. (#50)
-* Bug fix vertical align column headers. (#49, #52)
-* Bug fix vectorize text formatting arguments in rtf_page_header and rtf_page_footer. (#47, #53)
-* Bug fix text_format issue with all value equal to "". (#40)
-* `r2rtf` needs to work properly with `group_by()`. (#36)
+## New features
+
+* New argument `cell_vertical_alignment` in `rtf_*()` functions (#49, #52).
+* New argument `verbose` in `rtf_encode_list()` and `rtf_encode_table()` (#38).
+
+## Bug fixes
+
+* `unicode_latex` not found (#50).
+* Vertical align column headers (#49, #52).
+* Vectorize text formatting arguments in `rtf_page_header()` and `rtf_page_footer()` (#47, #53).
+* `text_format` issue with all value equal to `""` (#40).
+* r2rtf needs to work properly with `group_by()` (#36).
 
 # r2rtf 0.3.0 (2021-06-01)
 
-* Rename dataset with prefix `r2rtf` to avoid conflict of other namespace
-* Enable special place holder "-----" in `page_by` variable to suppress line displayed 
-  in `page_by` variable (ref Example 2 in `vignette/example-pageby-groupby`)
-* New experimental function `rtf_convert_format`.
-* New argument `pageby_row` in `rtf_body` to display first row instead of `page_by` variable when `pageby_row = "first_row"` 
-* New argument `subline_by` in `rtf_body` to display subline by an variable.  
-* New argument `text_indent_reference` to allow user to control reference of indent from page margin or table border (#12)
-* New internal function `rtf_subset` to subset an rtf table object.
-* Bug fix `group_by` can be used when `page_by=NULL`.
-* Bug fix `page_by` can not sort format style in `rtf_body`
-* Bug fix ensure consistent font size with blank cell (#14)
+## New features
+
+* New experimental internal function `rtf_convert_format()`.
+* New argument `pageby_row` in `rtf_body()` to display first row instead of
+  `page_by` variable when `pageby_row = "first_row"`.
+* New argument `subline_by` in `rtf_body` to display subline by an variable.
+* New argument `text_indent_reference` to allow user to control reference of
+  indent from page margin or table border (#12).
+* New internal function `rtf_subset()` to subset an RTF table object.
+
+## Bug fixes
+
+* `group_by` can be used when `page_by = NULL`.
+* `page_by` cannot sort format style in `rtf_body()`.
+* Ensure consistent font size with blank cell (#14).
+
+## Improvements
+
+* Rename datasets with prefix `r2rtf_` to avoid conflicts with other namespaces.
+* Enable special place holder `"-----"` in `page_by` variable to suppress line
+  displayed in the `page_by` variable. See example 2 in
+  `vignettes/example-pageby-groupby.Rmd`.
 
 # r2rtf 0.2.0 (2020-12-04)
 
-* Add `rtf_subline`, `rtf_page_header`, `rtf_page_footer`.
-* Add `rtf_page` to set page related attributes. 
-* Introduce `text_convert` argument to allow fixed string. 
-* Add `as_table` argument in `rtf_footnote` and `rtf_source` to allow footnote
-  and datasource inside or outside of a table.
-* Refactor `pageby` feature to enable `group_by` feature. 
-  Add `vignette\example-pageby.Rmd` to illustrate new pageby features.
-* Define `obj_rtf_border` and `obj_rtf_text` objects to standardize 
+## New features
+
+* Add `rtf_subline()`, `rtf_page_header()`, and `rtf_page_footer()`.
+* Add `rtf_page()` to set page related attributes.
+* Introduce argument `text_convert` to allow fixed string.
+* Add argument `as_table` in `rtf_footnote()` and `rtf_source()` to allow
+  footnote and data source inside or outside of a table.
+* Refactor the `pageby` feature to enable the `group_by` feature.
+  Add `vignettes/example-pageby.Rmd` to illustrate new `pageby` features.
+* Define `obj_rtf_border` and `obj_rtf_text` objects to standardize
   border and text attributes.
-* Add example ADaM datasets. 
-* Add validation tracker in `\inst` folder and testing cases in `\test`.
 
+## Improvements
+
+* Add example ADaM datasets.
+* Add validation tracker in `inst/` and test cases in `tests/`.
 
 # r2rtf 0.1.1 (2020-04-03)
 
-* Standardize input from `gt_tbl` to `tbl`
-* Resolving UTF-8 encoding 
+* Standardize input from `gt_tbl` to `tbl`.
+* Resolve UTF-8 encoding.
 
 # r2rtf 0.1.0 (Unpublished)
 
 * Added a `NEWS.md` file to track changes to the package.
-* Initial Version
+* Initial version.