R package of shinyapp

给R包加上一个shinyapp是一个不错的想法,可以将shiny交互方式作为R包的usage instructions的补充,user在使用前能先了解下这个R包能做的事。。。。

比如shinyjs的作者Dean Attali就给这个R包做了一个shiny网页,如:https://daattali.com/shiny/shinyjs-demo/

一般我们看到的最简单的R包(如myshinyapp)结构如下:

-myshinyapp
  |--DESCRIPTION (描述文件,包括包名、版本号、标题、描述、依赖关系等)
  |--R (函数源文件)
    |--function1.R
    |--function2.R
    |--...
  |--man (帮助文档)
    |--function1.Rd
    |--function2.Rd
    |--...
|--...

如果要在R包中加入app.R,则需要在将其放在inst文件夹中(如果shiny有的一些加载文件、www文件夹,则一并放入其中),inst 文件夹下的任何文件在安装包的时候都将被复制到包的根目录下,此时R包结果如下:

-myshinyapp
  |--DESCRIPTION (描述文件,包括包名、版本号、标题、描述、依赖关系等)
  |--R (函数源文件)
    |--function1.R
    |--function2.R
    |--runExample.R
    |--...
  |--man (帮助文档)
    |--function1.Rd
    |--function2.Rd
    |--runExample.Rd
    |--...
  |--inst (存放有shiny相关文件)
    |--shiny-examples
      |--shinyapp
        |--app.R
        |--www
        |--...
|--...

从上可看出runExample.R就是用于调用shiny的,用system.file函数来查找app.R文件所在路径,并用shiny::runApp来执行,如写个runExample函数,然后Ctrl+Shift+Alt+R加代码注释

#' Title
#'
#' @return
#' @export
#'
#' @examples
runExample <- function() {
  appDir <- system.file("shiny-examples", "shinyapp", package = "myshinyapp")
  if (appDir == "") {
    stop("Could not find example directory. Try re-installing `myshinyapp`.", call. = FALSE)
  }

  shiny::runApp(appDir, display.mode = "normal")
}

由于在R代码中使用了shiny包,因此在DESCRIPTION文件中将shiny包作为依赖包写入

然后取官网找一个shiny程序代码做个示例,如:https://github.com/rstudio/shiny-examples,取001-hello的app.R作为例子,放入shinyapp目录下

最后点击Rstudio上Build->Build and Reload加载myshinyapp包,再运行myshinyapp::runExample()生成shiny app

如果有多个shiny程序需要在R包中展示,则修改runExample函数,添加输入参数(代表需要展示的shiny程序名称,如shinyapp1, shinyapp2….),然后myshinyapp::runExample("shinyapp1")

最后则是将R包上传至Github上,用devtools::install_github安装即可

本文出自于http://www.bioinfo-scrounger.com转载请注明出处

文章目录
|