Как генерировать отчеты html / pdf из функции в пакете R - PullRequest
Новая
       10

Как генерировать отчеты html / pdf из функции в пакете R

1 голос
/ 18 июня 2019

Я хотел бы включить в свой пакет R функцию, которая генерирует отчет html / pdf, учитывая некоторые входные данные.

Например, давайте представим следующую функцию: 

#' @title Nice Report
#' @description It generates a nice summary report
#' @param x data.frame with column `column_whatever`
#' @param y data frame with column `column_whatever`
#' @param outputFormat Output format: either `pdf`(default) or `html` 
#' @return Either html/pdf summary report
#' @keywords QC, report
#' @examples
#' render_a_nice_report(x = data_example1, y = data_example2)
#' @export
render_a_nice_report <- function(x, 
                                 y, 
                                 outputFormat = "pdf"){

    # do some stuff with x and y
    z <- merge(x, y, by=(column_whatever))

    # Nicely print the data frame:

    #' ### Head of table resulting from merging x and y

    knitr::kable(head(z))

    #' ### Title 1: Distribution of variable 1

    plot1 <- ggplot(z) + geom_density(aes(v1))

    print(plot1)

    #' Some description of the plot above

    # Do something else to z

    k <- mypackage::do_whatever(z)

    #' ### Title 2: Histogram of Variable Var2

    plot2 <- ggplot(k) + geom_histogram(aes(var2))

# and finish rendering the report
}

Можно ли что-то подобное сделать в функции?

Если нет, как я могу добиться чего-то похожего с помощью функции в моем пакете? используя шаблон Rmd? но как это будет работать? Не могли бы вы привести пример существующего пакета R с функцией, выполняющей что-то вроде этого?

Заранее большое спасибо

...