Question

我想在我的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 Package的示例，该示例具有执行以下操作的功能？

非常感谢

如何从R包中的函数生成html / pdf报告

0 个答案: