class: center, middle, inverse, title-slide # From ShinyApps to R package ## Shinykorea 밋업 ### 김진섭 ### 2019-02-27 --- layout: true <div class="my-footer"><span><a href="https://www.anpanman.co.kr">ANPANMAN Co.,Ltd</a> &emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; &emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; <a href="https://github.com/jinseob2kim">김진섭</a></span></div> --- # Executive Summary 개인 PC에서 직접 **ShinyApps**를 이용할 수 있도록 -- .large[ - **ShinyApps**을 **[Rstudio Addins](https://rstudio.github.io/rstudioaddins/)**으로 만든 후, 이를 패키지로 만들어 **github**에 배포하였다. ] -- .large[ - **[testthat](https://github.com/r-lib/testthat)**, **[covr](https://github.com/r-lib/covr)**로 코드 테스트를 수행하고 결과 리포트를 만들었으며, **[pkgdown](https://github.com/r-lib/pkgdown)**으로 패키지를 소개하는 웹사이트를 만들었다. ] -- .large[ - **[Travis CI](https://travis-ci.org/)**와 **[appveyor](https://www.appveyor.com/)**로 2의 과정과 여러 운영체제에서의 테스트를 자동화하였다. ] -- .large[ - 최종적으로 **[CRAN](https://cran.r-project.org/)**에 패키지를 배포하였다. ] --- # ShinyApps <div class="figure" style="text-align: center"> <img src="https://camo.githubusercontent.com/aa4156b420be17d5ee0c39271486d13db4886712/68747470733a2f2f636f6d6d756e6974792e7273747564696f2e636f6d2f75706c6f6164732f64656661756c742f6f7074696d697a65642f32582f652f653134333064663830376335313335656437613234666565396639626238633339303330373831315f315f363930783336302e676966" alt="Basic statistics" width="100%" /> <p class="caption">Basic statistics</p> </div> Figure from <a name=cite-Takeuchi2018></a>[Takeuchi, Shinozaki, and Matsuyama [1]](https://doi.org/10.1186/s12874-017-0457-7) --- # Rstudio Addins <div class="figure" style="text-align: center"> <img src="https://camo.githubusercontent.com/96f270fef715ed29c4799a165e6de679def95c92/68747470733a2f2f626c6f672e616e70616e6d616e2e636f2e6b722f706f7374732f323031382d31312d32342d62617369632d62696f737461746973746963732f616464696e2e676966" alt="Rstudio Addins: jsmodule packages" width="100%" /> <p class="caption">Rstudio Addins: jsmodule packages</p> </div> --- # R packages .large[ [jsmodule](https://github.com/jinseob2kim/jsmodule): RStudio Addins와 Shiny Modules. ] -- .large[ Dependencies - [jstable](https://github.com/jinseob2kim/jstable): 회귀분석 테이블([CRAN](https://cran.r-project.org/package=jstable)) - [jskm](https://github.com/jinseob2kim/jskm): 카플란-마이어(Kaplan-meier) 그림([CRAN](https://cran.r-project.org/package=jskm)) ] --- class: center, middle # WHY --- # 파일제한 5메가 Shiny `fileInput`은 5메가 이하까지만 지원. -- 사실, 용량 제한 바꿀 수 있음. `shiny.maxRequestSize` 옵션을 **app.R**에 추가. ```r ## change to 30mb *options(shiny.maxRequestSize = 30*1024^2) ui <- navbarPage("Basic statistics", tabPanel("Data", ``` -- 서버 부하가 부담. 큰 데이터는 개인 컴퓨터에서 직접 하면 좋겠다. --- # 인터넷 차단 환경 건강보험 빅데이터 분석실은 인터넷 접속이 원천차단. - **R**, **Rstudio**, **Rpackage** 파일을 직원에게 미리 보내야 함. -- 심평원 분석실은 CRAN은 다운가능, github은 불가능. -- 데이터 정리까지만 수행, 분석은 연구자가 직접 할 수 있도록 계획. --- class: center, middle # [Rstudio Addins](https://rstudio.github.io/rstudioaddins) 만들기 --- # 데이터를 입력변수로 받는 함수 만들기. - ShinyApps의 `fileInput`을, **R**에서 데이터 읽는 것으로 바꿈. -- ```r ## app.R in ShinyApps server <- function(input, output, session) { output$import <- renderUI({ * csvFileInput("datafile") }) * data.info <- callModule(csvFile, "datafile") data <- reactive(data.info()$data) data.label <- reactive(data.info()$label) ... } * shinyApp(ui, server) ``` --- ```r ## Addin function jsBasicGadget <- function(data, nfactor.limit = 20) { * out <- data.table(data, check.names = T) ui <- navbarPage("Basic statistics", tabPanel("Data", ...) ) server <- function(input, output, session) { ... } * viewer <- browserViewer(browser = getOption("browser")) * runGadget(ui, server, viewer = viewer) ``` -- **Viewer options** - `paneViewer()`: Rstudio 우측 아래 **Viewer** - `dialogViewer()`: 따로 창을 실행 - `browserViewer()`: 따로 브라우저 실행 https://github.com/jinseob2kim/jsmodule/blob/master/R/jsBasicGadget.R --- # [miniUI](https://github.com/rstudio/miniUI) - Gadget용 간소화된 UI <div class="figure" style="text-align: center"> <img src="https://github.com/rstudio/miniUI/raw/master/tools/tabs.gif" alt="minuUI" width="80%" /> <p class="caption">minuUI</p> </div> --- ```r ui <- miniPage( gadgetTitleBar("Shiny gadget example"), miniTabstripPanel( miniTabPanel("Parameters", icon = icon("sliders"), miniContentPanel( sliderInput("year", "Year", 1978, 2010, c(2000, 2010), sep = "") ) ), miniTabPanel("Visualize", icon = icon("area-chart"), miniContentPanel( plotOutput("cars", height = "100%") ) ), miniTabPanel("Map", icon = icon("map-o"), miniContentPanel(padding = 0, leafletOutput("map", height = "100%") ), miniButtonBlock( actionButton("resetMap", "Reset") ) ), miniTabPanel("Data", icon = icon("table"), miniContentPanel( DT::dataTableOutput("table") ) ) ) ) ``` --- # 그러나 난.. .large[ 미리 만든 ShinyApps와 동일한 환경을 원함. - [miniUI](https://github.com/rstudio/miniUI) 안함 : ShinyApps의 UI 코드 그대로 이용. - `browserViewer()` 사용 : 웹브라우저에서 실행. ] --- # Addin 함수 만들기 - 드래그된 데이터이름을 인식하여 Gadget을 실행함 ```r jsBasicAddin <- function(){ * context <- rstudioapi::getActiveDocumentContext() # Set the default data to use based on the selection. dataString <- context$selection[[1]]$text * data <- get(dataString, envir = .GlobalEnv) jsBasicGadget(data) } ``` | | | |---|---| | `getActiveDocumentContext()` | Returns information about the currently active RStudio document. | | `insertText(location, text, id = NULL)` | Insert text at a specific location within a document. | | `setDocumentContext(text, id = NULL)` | Set the contents of a document open in RStudio. | --- # **addins.dcf** 파일 만들기. R 패키지 `inst/rstudio/addins.dcf` 에 만들기. ```sh Name: Basic statistics Description: Gadget including Data, Label info, Table 1, Regression(liear, logistic), Basic plot. Binding: jsBasicAddin Interactive: true ``` https://github.com/jinseob2kim/jsmodule/blob/master/inst/rstudio/addins.dcf --- <div class="figure" style="text-align: center"> <img src="addin.png" alt="Addin tab" width="80%" /> <p class="caption">Addin tab</p> </div> --- class: center, middle # R package 관리 --- # 패키지 상태 표현: Badge [](https://travis-ci.org/jinseob2kim/jstable) [](https://ci.appveyor.com/project/jinseob2kim/jstable) [](https://cran.r-project.org/package=jstable) [](https://CRAN.R-project.org/package=jstable) [](https://codecov.io/github/jinseob2kim/jstable) [](https://github.com/jinseob2kim/jstable/issues) [](https://github.com/jinseob2kim/jstable/stargazers) [](https://github.com/jinseob2kim/jstable/blob/master/LICENSE) ```md [](https://travis-ci.org/jinseob2kim/jstable) [](https://ci.appveyor.com/project/jinseob2kim/jstable) [](https://cran.r-project.org/package=jstable) [](https://CRAN.R-project.org/package=jstable) [](https://codecov.io/github/jinseob2kim/jstable) [](https://github.com/jinseob2kim/jstable/issues) [](https://github.com/jinseob2kim/jstable/stargazers) [](https://github.com/jinseob2kim/jstable/blob/master/LICENSE) ``` https://shields.io/ 에서 내 상태에 해당하는 뱃지를 얻을 수 있다. -- - **오류는 없고**, **인기는 많은** 패키지임을 과시? --- # 패키지 설명: 홈페이지 <img src="pkgdown.png" width="80%" style="display: block; margin: auto;" /> https://jinseob2kim.github.io/jskm/, https://jinseob2kim.github.io/jstable/, https://jinseob2kim.github.io/jsmodule/ --- # 홈페이지, test coverage를 자동으로 만들자. .large[ - 홈페이지: [pkgdown](https://pkgdown.r-lib.org/) - test coverage: [testthat](http://testthat.r-lib.org/), [covr](https://covr.r-lib.org/) - 자동 배포: [travis-ci](https://travis-ci.org/), [appveyor](https://www.appveyor.com/) ] --- # [pkgdown](https://pkgdown.r-lib.org/) 패키지 설치 후 **_pkgdown.yml** 파일에서 셋팅. `usethis::use_pkgdown()`으로 기본 설정 생성. ```yaml URL: https://jinseob2kim.github.io/jskm, https://github.com/jinseob2kim/jstable development: mode: auto authors: Jinseob Kim: href: https://github.com/jinseob2kim Anpanman: href: https://www.anpanman.co.kr html: <img src="https://raw.githubusercontent.com/anpanmancorp/Anpanman/master/horizontal_anpanman_transparent.png" height="24" /> template: params: docsearch: api_key: f6ab1678f68371b7775614662cffcb9d index_name: jstable ``` --- # 홈페이지 만들기 `build_site()` 실행하면 **/docs** 폴더에 홈페이지 만들어짐. <div class="figure" style="text-align: center"> <img src="https://github.blog/wp-content/uploads/2016/08/d516076e-640c-11e6-8086-ce1d246a87d2.png?fit=1460%2C860" alt="Setting webpage in github" width="60%" /> <p class="caption">Setting webpage in github</p> </div> 나중엔 [travis-ci](https://travis-ci.org/)를 이용, **gh-pages** 브랜치에 자동 배포. --- # [testthat](http://testthat.r-lib.org/) 함수의 테스트 코드를 작성하고 평가. - `usethis::use_testthat(), use_test()`로 기본 테스트 생성. `devtools::test()`로 테스트. ```r context("Show regression table") test_that("Run glmshow.display", { expect_is(glmshow.display(glm(mpg ~ cyl, data = mtcars)), "display") expect_is(glmshow.display(glm(am ~ cyl, data = mtcars, family = "binomial")), "display") }) test_that("Run cox2.display", { library(survival);data(lung) fit0 <- coxph(Surv(time, status) ~ ph.ecog + age, data = lung, model = TRUE) fit1 <- coxph(Surv(time, status) ~ ph.ecog + age + cluster(inst), data = lung, model = TRUE) fit2 <- coxph(Surv(time, status) ~ ph.ecog + age + frailty(inst), data = lung, model = TRUE) expect_is(cox2.display(fit0), "list") expect_is(cox2.display(fit1), "list") expect_is(cox2.display(fit2), "list") }) ``` --- # [covr](https://covr.r-lib.org/) 코드 테스트 리포트를 제공하는 [Codecov](https://codecov.io/)나 [Coveralls](https://coveralls.io/)를 위한 R 패키지. - `covr::codecov(), coverall()` 로 실행. - [testthat](http://testthat.r-lib.org/) 결과 기반 리포트. https://codecov.io/gh/jinseob2kim/jstable/tree/master/R <img src="codecov.png" width="75%" style="display: block; margin: auto;" /> --- # 귀찮다 .large[ 업데이트 때마다 **홈페이지**와 **코드리포트** 만들기 싫다. ] -- .large[ 사실, 패키지 **빌드(build) 체크**도 하기 싫지만 필요하긴 하다. 게다가.. - 내 컴퓨터에서 체크해봤자 리눅스환경만 확인한 것임. - 맥이나 윈도우에서 실행이 보장안됨. ] --- <img src="https://nesoy.github.io/assets/posts/20170105/travis-ci.jpg" width="75%" style="display: block; margin: auto;" /> [](https://travis-ci.org/jinseob2kim/jstable) .large[ [travis-ci](https://travis-ci.org/): 가장 유명한 **CI**(Continuous Integration) tool, github와 연동. - github commit 때마다 프로그램 **테스트, 빌드, 배포**가 자동 실행. - .travis.yml 에 설정 저장. ] https://travis-ci.org/jinseob2kim/jsmodule/jobs/495263115 --- ```yaml language: r cache: packages: true directories: - travis_phantomjs ## for shinytest matrix: allow_failures: - r: devel include: - r: devel - r: release r_packages: - covr after_success: - Rscript -e 'covr::codecov()' before_deploy: Rscript -e 'remotes::install_cran("pkgdown")' deploy: provider: script script: Rscript -e 'pkgdown::deploy_site_github()' skip-cleanup: true - r: release os: osx ## for Mac OS - r: oldrel ``` --- # [travis-ci](https://travis-ci.org/) with R package - `usethis::use_travis()` 로 **.travis.yml** 기본 설정파일 생성. ```yaml # R for travis: see documentation at https://docs.travis-ci.com/user/languages/r language: R sudo: false cache: packages ``` --- # Codecov `usethis::use_coverage("codecov")` 로 **.travis.yml** 에 `covr::codecov()` 실행 추가. ```yaml language: R sudo: false cache: packages r_packages: - covr after_success: - Rscript -e 'covr::codecov()' ``` --- # 홈페이지 빌드, 배포 [travis-ci](https://travis-ci.org/) 가 직접 github에 배포하기 위해 **gh-pages 브랜치와 key**가 필요. <img src="gh-pages.png" width="75%" style="display: block; margin: auto;" /> --- 1. github에서 **gh-pages** 브랜치 만들기. 2. **key** 생성: `travis::use_travis_deploy()` 를 **로컬 환경**에서 실행. <img src="key-travis.png" width="100%" style="display: block; margin: auto;" /> -- **.travis.yml** 에 추가 ```yaml before_deploy: Rscript -e 'remotes::install_cran("pkgdown")' deploy: provider: script script: Rscript -e 'pkgdown::deploy_site_github()' skip-cleanup: true ``` https://pkgdown.r-lib.org/reference/deploy_site_github.html --- # [appveyor](https://travis-ci.org/) .large[ [travis-ci](https://travis-ci.org/)는 리눅스와 맥만 지원 - **윈도우** 환경에서 테스트 못함. ] -- [](https://ci.appveyor.com/project/jinseob2kim/jstable) .large[ [appveyor](https://travis-ci.org/)는 리눅스와 **윈도우** 지원 - `usethis::use_appveyor()` 로 기본 **appveyor.yml** 파일 생성. ] --- ```yaml # DO NOT CHANGE the "init" and "install" sections below # Download script file from GitHub init: ps: | $ErrorActionPreference = "Stop" Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1" Import-Module '..\appveyor-tool.ps1' install: ps: Bootstrap cache: - C:\RLibrary # Adapt as necessary starting from here build_script: - travis-tool.sh install_deps test_script: - travis-tool.sh run_tests on_failure: - 7z a failure.zip *.Rcheck\* - appveyor PushArtifact failure.zip artifacts: - path: '*.Rcheck\**\*.log' name: Logs - path: '*.Rcheck\**\*.out' name: Logs - path: '*.Rcheck\**\*.fail' name: Logs - path: '*.Rcheck\**\*.Rout' name: Logs - path: '\*_*.tar.gz' name: Bits - path: '\*_*.zip' name: Bits ``` --- class: center, middle # CRAN 배포 --- # 평소에 잘 관리하자! .large[ - 빌드 check: WARNING 뿐 아니라 **NOTE**도 없어야됨. - 오타, 대소문자: 특히 **DESCRIPTION** 파일 - **README, NEWS, cran-comments** 작성. - 최소 하나의 **vignette** - 함수 설명: 충실하진 않더라도 빠진건 없어야. - 함수 example: 가급적 다 넣자. 한줄에 100글자 넘으면 안됨(**NOTE**). ] http://r-pkgs.had.co.nz/release.html --- # 오타, 대소문자 > Thanks, please write package names, software names and API names in single quotes (e.g. 'RStudio', 'shiny') in Title and Description. ```yaml Package: jsmodule Title: RStudio addins and Shiny modules for medical research Description: RStudio addins and Shiny modules for descriptive statistics, regression and survival analysis. Version: 0.7.10 Date: 2019-02-19 ``` -- ```yaml Package: jsmodule Title: 'RStudio' Addins and 'Shiny' Modules for Medical Research Description: 'RStudio' addins and 'Shiny' modules for descriptive statistics, regression and survival analysis. Version: 0.7.10 Date: 2019-02-19 ``` --- # 필수 markdown https://CRAN.R-project.org/package=jskm - **README.md**: CRAN의 REAMDE가 됨. - **News.md**: CRAN의 NEWS가 됨. - **cran-comments.md**: 패키지 자체 테스트 결과를 적는다. --- # cran-comments.md 예시 ```md ## Resubmission This is a resubmission. In this version I have: ** Add examples and tests for the non-UI functionality. ** Add examples to all Rd files. ## Test environments ** local Ubuntu 18.10 install, R 3.5.2 ** Ubuntu 14.04.5 LTS (on travis-ci), R 3.5.1 ** win-builder (stable and oldrelease) ## R CMD check results There were no ERRORs, WARNINGs or NOTEs. ## Downstream dependencies There are currently no downstream dependencies for this package ``` --- # Vignette .large[ `usethis::use_vignette("jsmodule")` 로 기본 파일 생성. - 귀찮으면 README 복붙하자. - 홈페이지에도 추가됨. ] --- # 함수 설명, example > Please omit example code that looks like this one: ```r \dontrun{ if(interactive()){ #EXAMPLE1 } } ``` -- > We see many Rd files with lines such as ```r \details{ DETAILS } \examples{ #EXAMPLE1 } ``` > These should alyways be deleted unless you have ral examples to insert. --- # interactive() examples >Thanks, unfortunately, your ceode is never tested at runtime, as you only have interactive() examples,if at all, and your test cases do not cover much code. >Can you perhaps add examples and tests for the non-UI functionality? -- .large[ 코멘트들을 반영하여 [jsmodule](https://github.com/jinseob2kim/jsmodule) 다시 **CRAN**에 신청한 상태. https://cransays.itsalocke.com/articles/dashboard.html ] --- # CRAN release 신청 .large[ `devtools::release()` 실행 - 확인 질문들이 나옴: 문제 없다고 답하면 됨. - 확인 메일 보고 몇 가지 클릭하면 완료. - **CRAN-RELEASE** 파일 생성됨: release 때 필요한 정보. - 진행과정 메일이 온다. 결정까지 10일 이내 ] --- # CRAN-RELEASE ```sh This package was submitted to CRAN on 2019-02-22. Once it is accepted, delete this file and tag the release (commit ec7a36c1d8). ``` -- .large[ CRAN 배포 확정되면 해당 commit 번호로 release ] https://github.com/jinseob2kim/jstable/releases --- # Executive Summary 개인 PC에서 직접 **ShinyApps**를 이용할 수 있도록 .large[ - **ShinyApps**을 **[Rstudio Addins](https://rstudio.github.io/rstudioaddins/)**으로 만든 후, 이를 패키지로 만들어 **github**에 배포하였다. - **[testthat](https://github.com/r-lib/testthat)**, **[covr](https://github.com/r-lib/covr)**로 코드 테스트를 수행하고 결과 리포트를 만들었으며, **[pkgdown](https://github.com/r-lib/pkgdown)**으로 패키지를 소개하는 웹사이트를 만들었다. - **[Travis CI](https://travis-ci.org/)**와 **[appveyor](https://www.appveyor.com/)**로 2의 과정과 여러 운영체제에서의 테스트를 자동화하였다. - 최종적으로 **[CRAN](https://cran.r-project.org/)**에 패키지를 배포하였다. ] --- class: center, middle # END --- # References <a name=bib-Takeuchi2018></a>[[1]](#cite-Takeuchi2018) Y. Takeuchi, T. Shinozaki, and Y. Matsuyama. "A comparison of estimators from self-controlled case series, case-crossover design, and sequence symmetry analysis for pharmacoepidemiological studies". In: _BMC Medical Research Methodology_ 18.1 (Jan. 2018). DOI: [10.1186/s12874-017-0457-7](https://doi.org/10.1186%2Fs12874-017-0457-7). URL: [https://doi.org/10.1186/s12874-017-0457-7](https://doi.org/10.1186/s12874-017-0457-7).