Skip to content

Commit 54d2259

Browse files
committed
Small documentation fixes
1 parent 736350e commit 54d2259

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

NEWS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
## Breaking Changes
44

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)
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)
66
* Renamed "plots" to "plot" in the `sections` argument. This ensures consistency with the data frame column names for plots, which are "plot.XX"
77
* `metadata.sample_id` is now always the first column in the data frame, even if you have provided a metadata function
88

99
## New Features
1010

1111
* 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
12+
* Add `plot_parsers` argument to `load_multiqc` which allows for custom parsers for diverse plot types in MultiQC
1313
* Add `plots` argument to `load_multiqc`, which is a vector of plot identifiers to parse
14-
* Add pkgdown website, which is available at <https://github.com/multimeric/TidyMultiqc>
14+
* Add pkgdown website, which is available at <https://multimeric.github.io/TidyMultiqc/index.html>
1515
* Add GitHub repository and issue tracker to package metadata [[#3]](https://github.com/multimeric/TidyMultiqc/issues/3)
1616

1717
## Bug fixes

R/multiqc.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
#' files, produced by the wonderful [MultiQC](http://multiqc.info/) tool,
44
#' into tidy data.frames for downstream analysis in R.
55
#' If you are reading this manual, you should immediately stop reading this and
6-
#' instead refer to the documentation website at <https://multimeric.github.io/TidyMultiqc/>.
6+
#' instead refer to the documentation website at <https://multimeric.github.io/TidyMultiqc/>, which
7+
#' provides more accessible documentation.
78
#' @importFrom magrittr `%>%`
89
#' @docType package
910
#' @name TidyMultiqc-package

man/TidyMultiqc-package.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)