|
2 | 2 |
|
3 | 3 | ## Breaking Changes |
4 | 4 |
|
5 | | -* Removed the `plot_opts` key from the `load_multiqc` function. Instead, the plots are returns as list columns with nested data frames inside the returned data frame. Users are then able to parse out summary statistics using normal `dplyr` and `tidyr` functions. Refer to the vignettes for examples. [[#1]](https://github.com/multimeric/TidyMultiqc/issues/1). Also, instead of selecting plots using the names of this argument, they are selected using the new `plots` option (documented below) |
6 | | -* Renamed "plots" to "plot" in the `sections` argument. This ensures consistency with the data frame column names for plots, which are "plot.XX" |
7 | | -* `metadata.sample_id` is now always the first column in the data frame, even if you have provided a metadata function |
| 5 | +* Removed the `plot_opts` key from the `load_multiqc` function. Instead, the plots are returned as list columns with nested data frames inside the returned data frame. Users are then able to parse out summary statistics using normal `dplyr` and `tidyr` functions. Refer to the vignette for examples. Also, instead of selecting plots using the names of this argument, they are selected using the new `plots` option (documented below) [[#1]](https://github.com/multimeric/TidyMultiqc/issues/1). |
| 6 | +* Renamed "plots" to "plot" in the `sections` argument. This ensures consistency with the data frame column names for plots, which are "plot.XX". |
| 7 | +* `metadata.sample_id` is now always the first column in the data frame, even if you have provided a metadata function. |
8 | 8 |
|
9 | 9 | ## New Features |
10 | 10 |
|
11 | | -* Add `list_plots()` utility function for listing the available plots. [[#2]](https://github.com/multimeric/TidyMultiqc/issues/2) |
12 | | -* Add `plot_parsers` argument to `load_multiqc` which allows for custom parsers for diverse plot types in MultiQC |
13 | | -* Add `plots` argument to `load_multiqc`, which is a vector of plot identifiers to parse |
14 | | -* Add pkgdown website, which is available at <https://multimeric.github.io/TidyMultiqc/index.html> |
15 | | -* Add GitHub repository and issue tracker to package metadata [[#3]](https://github.com/multimeric/TidyMultiqc/issues/3) |
| 11 | +* Added `list_plots()` utility function for listing the available plots [[#2]](https://github.com/multimeric/TidyMultiqc/issues/2). |
| 12 | +* Added `plot_parsers` argument to `load_multiqc` which allows for custom parsers for diverse plot types in MultiQC. |
| 13 | +* Added `plots` argument to `load_multiqc`, which is a vector of plot identifiers to parse. |
| 14 | +* Created a pkgdown website, which is available at <https://multimeric.github.io/TidyMultiqc>. |
| 15 | +* Added documentation for the plot parsers, which explains the format of the nested data frame produced for each plot type. |
| 16 | +* Added GitHub repository and issue tracker to package metadata [[#3]](https://github.com/multimeric/TidyMultiqc/issues/3). |
16 | 17 |
|
17 | 18 | ## Bug fixes |
18 | 19 |
|
19 | | -* Fix errors when the data frame contains no data (for example because you only requested a single plot which isn't present) [[#2]](https://github.com/multimeric/TidyMultiqc/issues/2) |
| 20 | +* Fixed errors when the data frame contains no data (for example because you only requested a single plot which isn't present) [[#2]](https://github.com/multimeric/TidyMultiqc/issues/2). |
0 commit comments