NEWS.md
In mcguinlu/robvis: Visualize the Results of Risk-of-Bias (ROB) Assessments

robvis 0.3.0.900 (Development)

As part of a major overhaul of the code in order to improve maintainability and user-friendliness, there have been a number of significant changes made in this version.

Breaking changes
There are now stricter conditions placed on the data provided to robvis based on the options specified, which also address some niche cases which were causing bugs. Informative messages are provided to users if the data is not compatible with their chosen options. Existing code may have to be updated - I am sorry for this, but this should make it easier to support long-term stability of the API
The default point size for rob_traffic_light() has been changed from 20 to 10. This is because, following a review of published robvis plots, users are not changing the defaults very often and in almost all cases, a smaller default looks better. While existing code will continue to work, the resulting plots will look different unless the psize argument was explicitly defined.
A new logical argument, overall, which allows users to specify whether to include an "Overall" column in the traffic light plot, has been added to rob_traffic_light() (default is TRUE). In order to have consistent behaviour across the two main functions, the default of the overall argument inrob_summary() has been changed from FALSE to TRUE [I admit that I'm not sure why I set it to FALSE in the first place]. While existing code will continue to work, the resulting plots will look different unless the overall argument was explicitly defined.
The default the weighted argument for rob_summary() has been changed from TRUE to FALSE, both to ensure better consistency across the two main functions (rob_traffic_light() does not require a "Weight" variable) and to reduce a hurdle to usage among new users. While existing code will continue to work, the resulting plots will look different unless the weighted argument was explicitly defined.
The example datasets in the package now no longer include a weight column. This is to make using weights to produce a weighted barplot a specialised endeavour rather than the default behaviour for the package. This maps to the change to weighted = FALSE as the default for rob_summary().
The overall argument in the "Generic" now acts slightly differently both to previous versions of the function and to the other templates. Rather than removing an additional column from the dataset if overall = FALSE, which doesn't make sense if their data doesn't contain an overall column, it simply highlights the last column (in rob_traffic_light()) or bolds the last heading (in rob_summary()).
In order to make the "Generic" template for rob_summary() compatible with tools that have 4 levels of judgement (e.g. the ROBINS-I tool), users must now specify a name for all levels if using the judgement_labels argument of rob_summary(). Existing code that uses the judgement_labels argument will need to be updated.
Major updates
Two new functions for working with the output of metafor meta-analyses have been added. rob_forest() adds a traffic-light plot to the right hand side of the standard metafor::forest() output. rob_append_weights() extracts the weights assigned to each study in the meta-analysis and appends them to the risk of bias dataset. A vignette describing these two new functions has been added.
A template for the QUIPS tool (prognostic studies) has been added.
The "Generic" template now allows for additional customisation, including control over all text in the resulting figure.
A new function, rob_save(), has been added, which uses data-driven defaults for figure height and width when saving to a file.
New functionality so that robvis now supports "No information" as a judgement has been added.
An improved colour scheme for the colour = "colourblind"argument has been added.
The argument for the generic template has changed from "ROB1" to "Generic". To ensure backward compatibility, the "ROB1" argument is still accepted, but a message is returned to indicate that it may be depreciated in the future.
The "Generic" template has been updated, so that it no longer maps "Serious" and "Critical" to the same colour/symbol.
The overall argument in rob_summary() now bolds the "Overall" axis label.
Minor updates
A major refactoring of the code base has taken place to allow for future template specific functionality.
Improved test coverage.
Allowed for US spelling of "colourblind""
rob_tools() now returns a message indicating the availability of templates for each function.

robvis 0.3.0 (October 2019)

Major updates
rob_traffic_light() can now handle a summary table with or without a "Weight column". rob_summary() still requires a "Weight" column, as it is strongly encouraged that weights be used to create the summary barplot.
Functions can now handle summary tables with less than the expected number of judgments. For example, for ROB2, a sheet with only "Low" and "Some concerns" would cause the resulting graph to be inverted and mess up the ordering of the legend. This issue is now fixed for both rob_summary() and rob_traffic_light().
The shapes indicating the risk-of-bias level in rob_traffic_light() have been updated.
rob_traffic_light() no longer orders studies alphabetically, instead retaining the order from the uploaded CSV.
The order of the domains in rob_summary() has been corrected to accurately reflect the order of domains in each tool, rather than presenting them in alphabetical order.
Legends for rob_traffic_light() are now ordered by ascending/descending (depending on the tool) risk of bias.
Minor updates
CODE_OF_CONDUCT and CONTRIBUTING documents have been added to the GitHub repo.
A PR template has been added to the GitHub repo.

robvis 0.2.0 (May 2019)

Major updates
Removed "save" argument from both the rob_summary() and rob_traffic_light() functions. In line with CRAN guidelines, this element was removed as packages should not write to the file system.
Added "weighted" argument to rob_summary() to allow users to choose whether to create a weighted or unweighted barplot.
Added a new generic template (tool = "ROB1") which allows users to have a nonstandard number of bias domains. This template takes the columns headings of user-defined domains and passes them to the caption of the resulting figure.
Minor updates
New functionality for users to choose color-scheme or provide their own vector of colors for use in the plots. Preset options include traditional "Cochrane" colours and a colourblind friendly palette.
Improved text processing to allow for imperfect matching of judgments, primarily to allow for differences in cases (e.g. "low" will match with "Low"), minor spelling errors (e.g. "loq" will match with "Low"), and a leading whitespace (e.g. " loq" will match with "Low").