Skip to content

Latest commit

 

History

History
553 lines (353 loc) · 19.6 KB

NEWS.md

File metadata and controls

553 lines (353 loc) · 19.6 KB

kableExtra 1.4.0.11

New Features:

  • Added show_every_page argument to footnote() (#867).
  • Added class argument to cell_spec() (#871).
  • add_header_above() now supports specifying line as a vector (#700).
  • add_header_above() and linebreak() now accept more exotic align specifications, e.g. p{2cm}.

Bug Fixes:

  • Fixed a bug in collapse_rows(), which failed on tables that had no header (#812).
  • Fixed a bug in row_spec() which added extra line breaks when extra_latex_after was specified (#815).
  • Fixed a bug in kable_styling() which didn't parse "pipe" tables containing multibyte characters properly (#821).
  • Fixed a bug in add_header_above() which caused headers containing LaTeX code to be rendered incorrectly in LaTeX documents (#836).
  • Fixed a bug in save_kable_latex() which left the user in the wrong directory if an error occurred (#865).
  • Fixed a bug in magic_mirror_latex() which stopped it from working with tabularx tables (#861).
  • Complex alignment options like p{1cm} were not handled properly by kable_styling() (#876).

kableExtra 1.4.0

New Features:

  • Added live preview of inline plots (#777).
  • Add feature to scale_up and scale_down latex tables (#753)
  • Added row grouping feature with row_group_label_position = first option (#711).
  • Expanded the functionality of spec_color to allow arbitrary palettes.
  • Removed dependency on rvest and glue
  • In previous versions, kableExtra manipulated knitr's global settings to auto format tables. In 1.4.0, we introduced a markdown table parser, which will parse the inputting markdown table back to a dataframe and resend it to the kbl function. In this way, all the auto formatting happens within this package. In terms of latex table specifically, we also turned on booktabs and longtable by default to mimic the default behavior of how pandoc handle markdown tables. As a result, most users won't even feel the change. The only part that gets impacted is the table labels or references set within the kable function through the label option. For this part, first, people can set labels using knitr chunk options. Also, people can easily overcome it by either using kbl or setting format in kable.
  • Added line_col to spec_pointrange()

Improvements:

  • Updated kbl() parameters to match current knitr version 1.45 (#784).
  • Adjusted placement of collapsed row labels to account for cmidrules within a section (#787).
  • Enhanced footnote examples and fixed footnote label when notation is "none" in "pipe" output (#792).
  • Enhanced text input for font_size for better customization (#576).

Bug Fixes:

  • Fixed a bug in current column_spec that prevents finding the correct rows (#791).
  • Resolved centering issue of three-part tables (#789).
  • Corrected behavior of special characters in captions (#788).
  • Fixed obscure but legal case with YAML in multi-output context (#781).
  • Addressed issue with blank table in Rmarkdown inline rendering with dark-themed Rstudio (#689).
  • Fixed output type detection in .onLoad and handled HTML kable object including extra stuff, like a style block.
  • Fixed minor spelling errors and typos in various places (#779, #709, #710, #676).
  • Resolved issue with auto_format default setting (#749).
  • Some table additions didn't work with custom rule widths (#806).

Documentation and Maintenance:

  • Documented special cases and added heads-up about typo in linebreak.R (#679).
  • Added GitHub action to run R CMD check, necessitating pdflatex and vignette compaction (#780).
  • Defaulted to booktabs=TRUE, longtable=TRUE when converting a pipe table (#778).
  • Declared LaTeX packages with each kbl() call and exported use_latex_packages() for user flexibility (#782).

Misc:

  • Converted CSS colors like "darkgoldenrod2" to rgba() form for better compatibility (#785).
  • Made various minor changes and namespace qualifications for improved functionality.
  • Merged various pull requests improving codebase and resolving issues (#800, #799, #797, #798, #794, #793, #768, #632, #628, etc.).

kableExtra 1.3.1, 1.3.3, 1.3.4

  • Bug fixes

kableExtra 1.3.0

Major Change

  • Added a header_separate function that simplifies the workflow of adding header rows to grouped data. For example, if the original dataframe has columns in the form of "var", "a_mean", "a_sd", "b_mean" and "b_sd", this header_separate will change the column names of the 1st row to be "var", "mean", "sd", "mean" and "sd" and add an additional row with group a and b there.

  • @r2evans significanntly improved the previous spec_** functions to generate mini plots. He also added a more general spec_plot function to use the base R general plot function (scatter, line / polygon).

  • Added a spec_pointrange function for forest-plot like figures.

Bug fixes

  • Quite a lot. Somehow I forgot to document these changes this round...

kableExtra 1.2.1

Major Change

  • Added a kable function as a wrapper of the original kable but provides better documentation and auto-complete. We also moved the automatic format setup piece into the kable function call instead of changing global option during package start-up.

  • Added a few alternative HTML table themes. See https://haozhu233.github.io/kableExtra/awesome_table_in_html.html#Alternative_themes. (#451)

  • column_spec now takes vectorized input so it's easier to do conditional formatting without using cell_spec.

  • Added tools to include images and inline plots in column_spec.

Minor Change

  • add_indent has a new option level_of_indent to control the width of the indentation. (thanks @samiaab1990 #479)

  • add_indent has a new option all_cols to control whether the indentation should be applied to the first column or all columns. Default is False. (#488)

  • Removed xcolor from latex dependency list

  • collapse_rows has a new option target to choose the target column in collapse_rows (#484)

  • Added mathjax to HTML preview (#473)

  • Added a new function remove_column for html. The latex part hasn't been implemented yet. (#490, thanks @DanChaltiel)

  • Added a global option to control whether to preview HTML tables in RStudio viewer. If you want to disable the default behavior, try to set options(kableExtra_view_html = F). (#455)

  • Added a new_tab option to cell_spec to control whether to open up links in new tab. (#454)

  • Improved the behavior of scroll_box so it will skip non-html tables. (#450)

  • Added a html_font option to kable_styling and its variants.

  • Added a wraptable_width to kable_styling (#414)

  • Added monospace, underline, strikeout, color and background to pack_rows(). (#412)

  • Added documentation for how to use sparkline.

Bug Fix

  • Fixed a bug with group_rows when used with repeat_header on the last row (#476)

  • Fixed a bug with repeat_header when the header row is customized (#480)

  • Fixed a bug with collapse_rows when text is too long. (#464)

  • add_header_above now can take a data.frame as input. (#440, thanks @jokorn)

  • Fixed a bug when using UTF-8 on non-UTF-8 system. (#440, thanks @jokorn)

  • Fixed a bug in collapse_rows when there is no column names (#459)

  • Fixed a bug for add_header_rows when there isn't thead in HTML (#246, #423, thanks @kbrevoort)

  • Fixed inconsistent behavior for add_header_rows in HTML and latex (#387, #422, thanks @kbrevoort)

  • Fixed a bug for group_rows for longtable with repeated_header but without booktabs. (#331)

  • Fixed a bug for group_rows with certain duplicated rows input (#303, #304, thanks @tomjemmett)

  • Fixed the include_empty option in add_header_above. (#367, #393, thanks @trianglegirl)

  • Fixed a bug with pack_rows when escape is F. (#396)

  • Fixed a bug with collapse_rows when used together with pack_rows. (#430)

  • Fixed a bug with pack_rows when longtable is enabled. (#410)

kableExtra 1.1.0

Major Changes

  • pack_rows was added as an alias to group_rows and is now the preferred term for this feature as dplyr 0.8.0 instroduced a function with the same name.

  • HTML Font and Background Colors now gets a "!important" tag so they can be printed out under bootstrap

Minor Changes

  • Added a fixed_header option to kable_styling. (Similar with the same option in scroll_box)

Bug Fixes

  • LaTeX packages now only loaded in latex environment so there won't be memory leaking issues in html_notebook.

  • Fixed an typo in stripe_index

kableExtra 1.0.1

Bug Fixes

  • Fix issue where HTML results cannot be displayed inline (#330)

  • Fix extra texts with save_kable for HTML (#310)

kableExtra 1.0.0

Major Changes

  • save_table will be able to save HTML tables to png, jpg and PDF using webshot automatically.
  • Removed xcolor dependency for recent updates in fancyvrb, which causes a xcolor option clash.
  • Added formatting options to add_header_above.
  • Exported kable_as_xml and xml_as_kable.
  • Added a xtable2kable function to support most xtable output.

Minor Features

  • Added symbol_manual to footnote so that users can manually customize the sequence of symbols in footnote.

Bug Fixes

  • Fixed an issue that prevents linebreak works with factor
  • Moved a lot LaTeX function options to the top level for easier selection.
  • ...

kableExtra 0.9.0

  • Major Change: Now when you load kableExtra package, it will automatically set format for kable() based on the working environment: only if you are using R Markdown or R Sweave to render PDFs, the default format will be set to "latex". Otherwise it will be set to "html".

  • Major Change: Now kableExtra will try to load the table section of the bootstrap stylesheet when you are rendering slidy_presentation & ioslides_presentation. You can also choose to load it manually via the global option kableExtra.html.bsTable.

  • Added support to the tables package. (Thank you @dmurdoch)

  • Added a save_kable function to save HTML table as independent HTML pages.

  • Added min_width and max_width to column_spec.

  • Added documentation about 100% width in scroll_box (Thank you @isteves!)

  • Added include_thead to column_spec. (#177)

  • Fixed a few bugs in linebreak (#167, #180)

  • Fixed a bug when there is no column header row in LaTeX (Thank you @leovan)

  • Fixed header formatting for repeated header row in latex longtable (#183)

  • Removed the \small tag in threeparttable (#162)

  • Added valign to collapse_rows to adjust vertical position of the contents. Change default setting from middle to top. (#191)

  • Added an auto_index function to facilitate group_rows. (#193)

  • Added a title_format option to footnote and changed default format from bold to italic. (#200)

kableExtra 0.8.0

  • Now kableExtra imports & exports knitr::kable so users don't need to load knitr entirely to NAMESPACE when it's not necessary, for example, in shiny.

  • Fixed #115, a bug in latex footnote about escaping.

  • Fixed #116, a bug about the position of footnote in longtable with booktabs

  • Fixed #119, a bug between collapse_rows and add_header_above

  • Improve footnotes in longtable and replace threeparttable with threeparttablex. Now footnotes works smoothly in longtable, even with full width in tabu.

  • Fixed #135, a bug in footnote_marker_symbol

  • Added a new layout for collapse_rows, thanks @georgegui! #159

  • Added the linebreak function to support adding linebreaks to LaTeX table.

  • Added internal support to convert \n to linebreak in table to all kableExtra functions for both LaTeX and HTML

  • Added a document about wrapping texts and adding linebreaks.

  • Fixed a bug related to the handling of special characters

  • Remove HTML to Word doc from vignette because it's too large.

  • Fixed varies other bugs.

kableExtra 0.7.0

  • Now HTML table will be previewed in Viewer panel

  • Added HTML color code support to kableExtra

  • Added footnote as a more flexible replacement for add_footnote. Add_footnote() will be kept maintained for a while.

  • Fixed bug #105: bold/italic/monospace cannot accept T/F as vector

  • Added extra_css to cell_spec, row_spec & column_spec

  • Fixed bug #88: add_footnote doesn't support full width

  • Added hline_after and extra_latex_after to row_spec #101

  • Improved warning message for kables not in html or latex

  • Added latex_hline to collapse_rows so users can choose from full, major or none

  • Added strikeout and underline to column_spec, row_spec and cell_spec.

  • Added extra_css to column_spec, row_spec and cell_spec.

  • Added a vignette about how to copy tables from HTML to Word.

  • Change some read_xml to read_html

  • Added scale_from to some spec_tools

  • Quite a few minor bug fixes

kableExtra 0.6.1

  • Fixed a bug in column_spec width introduced in ver 0.6.0

  • Fixed a bug in add_header_above. #90

kableExtra 0.6.0

  • Added cell_spec for HTML & LaTeX

  • Added helper functions including spec_color, spec_font_size, spec_angle, spec_tooltip & spec_popover to facilitate the cell_spec function.

  • Added align/rotate/font_size to row_spec

  • Allowed row_spec to modify header row with row_spec(0, ...)

  • Improved repeat_header in LaTeX for longtables. Now you can write texts like "continued on next page"

  • Fixed a critical bug with latex group_rows (#68)

  • Escape question mark ? in regex_escape (thanks @nichtleiter)

  • Switched from readr::write_file to base::writeLines (for support in earlier version of readr)

  • Switched from sub to str_replace in some places due to a bug in sub on Windows.

kableExtra 0.5.2

  • Request from CRAN: Changed dependency on magick from Imports to Suggest. Added error message when users don't have magick installed.

  • Added argument index to group_rows so users can build multiple row groups in one step. The syntax is the same with add_header_above

  • Now row_spec and column_spec can take vectors so users can customized multiple row/columns at the same time.

  • Fixed a bug for kable_as_image on Windows. Improved documentations and error messages.

kableExtra 0.5.1

  • Added documentations about those color/background color options in column_spec and row_spec

  • Added the kableExtra_latex_packages function to quickly print all necessary LaTeX packages on the screen.

  • Hot fix a bug in full_width in LaTeX

kableExtra 0.5.0 (a big LaTeX update)

  • Now column_spec & row_spec can customize font & cell background color with 2 new options color & background. Also, you can draw border lines using border_left or border_right when you are using column_spec.

  • Making it optional to pre-load LaTeX package on package startup

  • Adding documentations about dependencies on LaTeX packages and the auto-load behavior of kableExtra

  • Improved the look of full_width in kable_styling LaTeX and add tabu to LaTeX dependency

  • Added enc2utf8() to improve behavior in non-UTF8 machines.

  • Added HOLD_position, which uses LaTeX package float and H, for a stronger hold on table position. (Thanks @robshep)

  • Move conditional usepackage_latex() calls to zzz.R for more consistant behavior

  • Now you can change strip color for LaTeX tables.

  • Added support to tables with caption.short.

  • Added kable_as_image() for LaTeX tables. This function will render the LaTeX code snippet to a piece of standalone PDF file and then convert that to an image, which will then be included in the R Markdown document, if the environment exists. It's useful for people who have a strong need of generating Word documents and producing well-formatted LaTeX table at the same time.

  • For both HTML & LaTeX, added escape option for add_footnote

  • Fixed a bug in LaTeX for the processing of the + sign

  • Fixed a bug with the [ symbol in escape_regex

kableExtra 0.4.0

  • Add scroll_box for HTML table for extremely long/wide tables

  • Fixed a bug in collapse_row on removing addlinespace

  • Removed addlinespace from group_rows

  • Added monospace to column_spec & row_spec

  • Lowered R version requirement to R 3.1.0

  • Added testthat (#28, thank you @wibeasley)

  • For all HTML table functions, changed reading method from xml2::read_xml to xml2::read_html plus some extra steps to avoid errors when HTML contents don't fulfill XHTML requirements (#24)

  • For all HTML table functions, improved exportation method to remove the XML declaration. (Stackoverflow: https://stackoverflow.com/questions/45262308/knit2wp-adds-text-with-kableextra)

  • Added repeat_header_method in kable_styling (#25)

  • Fixed a bug in position in kable_styling() (https://stackoverflow.com/questions/45378664/kableextra-rmarkdown-tables-aligning-grouping-row-labels-and-footnotes)

  • Improved striped line look on tables with multiple layers of header rows. (#31)

  • Added escape to add_header_above and group_rows

  • Added PDF vignette to the CRAN vignette folder

kableExtra 0.3.0

  • Improved the look of HTML grouped header row (again) by adding spaces between groups

  • Fixed a bug in grouped header row.

  • Fixed a bug in grouped rows: https://stackoverflow.com/questions/44360040/group-rows-function-in-kableextra-package-not-grouping-rows

  • Fixed a bug in grouped rows with ()[].

  • Added a new LaTeX option repeat_header in kable_styling for repeating header rows in a longtable environment.

  • Fixed a bug in add_header_above to allow special symbol in extra header rows.

  • Allow column_spec automatically align when width is specified.

  • Added bold/italic options to add_header_above.

  • Added collapse_rows to collapse repeated rows to multirow cell

  • Improve package-level documentation based on @wibeasley's suggestion

kableExtra 0.2.1

  • Added column_spec() to customize the look of the selected column.

  • Improved the look of HTML grouped header row.

  • Fixed an error in a documentation.

kableExtra 0.2.0

  • Added add_indent() feature to add indentations to rows in HTML and LaTeX.

  • Added group_rows() feature to group rows together in HTML and LaTeX.

  • Changing font_size in kable_styling won't affect table caption any more.

  • Fixed a bug in scale_down in kable_styling on landscape page in LaTeX.

  • Changed stop to message on format checking.

  • Added an example for how to use it in Shiny.

  • Fixed a few errors in the LaTeX vignette file.

kableExtra 0.1.0

  • Initial Release