NEWS.md
Thanks to @mariabnd for contributing to this release.
render_country_report from producing a country level report. Added tests to flag this in the future.run_tb_dashboard so that render_country_report runs without errors.ggplot2 best practises (#77).summarise_tb_burden that caused an error when confidence intervals were not wanted and rates were estimated for countries.summarise_metric function to the package. This function was previously used internally by the TB report. For a given year it returns the value of given metric, along with the regional and global rankings. The average change over the last decade is also supplied. Linked to #57.search_data_dict can now be used to search for a dataset by name. All variables in this dataset are then returned.available_datasets, that lists the datasets available to be imported into R using the package. This dataframe also gives a short description of each dataset, details the timespan of the dataset, and whether or not it is downloaded by default. Used by get_tb_burden as a URL source for downloading the datasets. Linked to #58.get_tb_burden can now import additional datasets (listed in available_datasets), clean them, and then link them with the core dataset. This adds over 400 new variables to the package and provides a near complete list of data used in the WHO Tuberculosis global report. Please open an issue if you find an issue with this dataset.0.6.0 to signal a major release.3.3.0.getTBinR and also added this information to the README.search_data_dict has improved messaging and no longer returns an error when nothing is found in the data dictionary. From #65.search_data_dict has expanded testing to account for new dataset searching and for failing to find results. Linked to #60.dplyr::funs as soft deprecated.summarise_metric and added to documentation.get_tb_burden. #58available_datasets and new data import to the README and to the getting started vignette.usethis::use_tidy_description to improve DESCRIPTION formatting.3.2.0.usethis::use_tidy_versions() to set package to dependent on package versions used during development work. Added this to makefile to make automated.Makefile use with `make message=“your commit message”. This will automatically run all build steps that are required and then commit any changes.annual_change to summarise_tb_burden and added validating tests.summarise_tb_burden and added validating tests.plot_tb_burden_summary. Function wraps summarise_tb_burden and allows all in one summary plotting. Inspired by this case study.rmarkdown parameterised country level report on TB.run_tb_dashboard.render_country_report to generate a TB report for a given country.map_tb_burden to not use geom_path for country outlines.smooth argument to plot_tb_burden to allow smooth trend lines to be plotted (derived using ggplot2::geom_smooth).plot_tb_burden to improve plot appearance.legend argument to all plotting functions to allow control of the legend appearance.plot_tb_burden and plot_tb_burden_overview. This allows a range of years to be plotted. The default is all years which was the previous de-facto default.pkgdown.map_tb_burden.summarise_tb_burden function for summarising metrics across regions, across custom groups and globally.annual_change argument to all plotting/mapping functions. Passed to prepare_df_plot. Returns the percentage annual change for the supplied metric.trans argument to all plotting functions to allow scaling using any ggplot2::continous_scale trans argument.run_tb_dashboard to launch a shiny dashboard for exploring global tuberculosisget_data functions are called.utils::read.csv for downloading the data when fread::data.table fails. Related to this issue.download_data argument to all functions to make downloading data explicit.save argument to all functions to make saving the data explicit.save_name and path arguments to all functions to make location of saving explicit.tempdir())