如何获得R包的rmarkdown插图以逃避Solaris和OSX上的CRAN警告

时间:2018-06-11 00:13:29

标签: r r-markdown knitr cran

我在CRAN上有几个R软件包,它们针对与pandoc无关的Solaris(有时是OSX)警告不能用于插件构建。例如,以下是ggseas results on CRANsource code for the vignette - 从提交给CRAN的版本略有变化,但没有任何相关方式。

粗略的谷歌搜索表明这个问题很常见。在GitHub上为单个软件包找到十几个问题也很容易,但我无法找到任何表明解决方案的问题。据推测,CRAN维护者只是让这一个过去,但如果是这样的话,它并不整洁。我不想勾选说出“#34;我已经解决了上次提交的任何注释和警告”#34;当它不是真的。

现在,一些幸运或技术熟练的人有不会引起这个问题的恶意攻击。例如,tidyr vignette执行not have any warnings for Solaris and OSX on CRAN。但是我不能在tidyr小插曲的序言中看到任何不同的东西:

---
title: "Tidy data"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Tidy data}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

或描述文件中包含此行的

VignetteBuilder: knitr

这与我的小插图不同,它确实引发了警告。这就是我所拥有的:

---
title: "ggseas - seasonal decomposition on the fly"
author: "Peter Ellis"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{ggseas - seasonal decomposition on the fly}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

我在"建议"中也有knitrrmarkdown。描述文件,这是在各种问题讨论中提到的一个解决方案(通常后跟"但它没有解决它")。

我错过了什么?避免在CRAN上创建这些警告的秘诀是什么?不幸的是,很难对此进行试验,所以如果我们能够为所有受此困扰的人们获得明确的答案,那将会很棒。

编辑/添加 - 完整的描述文件

Hadley Wickham建议问题最有可能出现在软件包的DESCRIPTION文件中,而不是插图本身。

以下是ggseas的描述文件,该文件包生成警告:

Package: ggseas
Title: 'stats' for Seasonal Adjustment on the Fly with 'ggplot2'
Version: 0.5.4
Authors@R: c(
   person("Peter", "Ellis", , "peter.ellis2013nz@gmail.com", c("aut", "cre")),
   person("Christophe", "Sax", role = "ctb")
   )
Maintainer: Peter Ellis <peter.ellis2013nz@gmail.com>
Description: Provides 'ggplot2' 'stats' that estimate seasonally adjusted series 
    and rolling summaries such as rolling average on the fly for time series.
Depends:
    R (>= 3.1.2), 
    ggplot2 (>= 2.0.0)
Imports:
    seasonal, 
    rlang,
    stats,
    zoo
License: GPL-3
LazyData: true
RoxygenNote: 6.0.1
BugReports: https://github.com/ellisp/ggseas/issues
Suggests: testthat,
    knitr,
    rmarkdown
VignetteBuilder: knitr

以下是tidyr的描述文件,该包不会产生警告:

Package: tidyr
Title: Easily Tidy Data with 'spread()' and 'gather()' Functions
Version: 0.8.1.9000
Authors@R: c(
    person("Hadley", "Wickham", , "hadley@rstudio.com", c("aut", "cre")),
    person("Lionel", "Henry", , "lionel@rstudio.com", "aut"),
    person("RStudio", role = "cph")
    )
Description: An evolution of 'reshape2'. It's designed specifically for data
    tidying (not general reshaping or aggregating) and works well with
    'dplyr' data pipelines.
License: MIT + file LICENSE
URL: http://tidyr.tidyverse.org,
    https://github.com/tidyverse/tidyr
BugReports: https://github.com/tidyverse/tidyr/issues
Depends: 
    R (>= 3.1)
Imports: 
    dplyr (>= 0.7.0),
    glue,
    magrittr,
    purrr,
    Rcpp,
    rlang,
    stringi,
    tibble,
    tidyselect
Suggests: 
    covr,
    gapminder,
    knitr,
    rmarkdown,
    testthat
LinkingTo: 
    Rcpp
VignetteBuilder: knitr
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 6.0.1

第二次编辑/添加 - 可在rhub

上重现

以下是我在Solaris平台上使用rhub::check(...)时看到的内容。这里有一些线索,问题与图像有关,符合one suggestion on Twittertidyr晕图没有图像)。因为没有图像我的小插图没有任何意义(这是一个图形包),这可能让我感到难过。

✔  checking package vignettes in ‘inst/doc’
─  checking running R code from vignettes ...
      ‘ggseas.Rmd’ using ‘UTF-8’ ... OK
    NONE
W  checking re-building of vignette outputs
   Error in re-building vignettes:
     ...
   Warning in engine$weave(file, quiet = quiet, encoding = enc) :
     Pandoc (>= 1.12.3) and/or pandoc-citeproc not available. Falling back to R Markdown v1.
   Warning in (function (filename = "Rplot%03d.png", width = 480, height = 480,  :
     unable to open connection to X11 display ''
   Quitting from lines 47-49 (ggseas.Rmd) 
   Error: processing vignette 'ggseas.Rmd' failed with diagnostics:
   unable to start device PNG
   Execution halted

1 个答案:

答案 0 :(得分:0)

已经有一段时间了,您似乎还没有解决问题。

我的一个 imputeTS 包 (vignette) 上也有一个 R 降价小插图。它有很多用 ggplot2 创建的图像,所以我认为问题不在于一般的图像。

我对 .Rmd 文件有完全相同的注释

MARKDOWN .Rmd 文件:

---
title: "Gallery: Times Series Missing Data Visualizations"
author: "Steffen Moritz"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Gallery: Times Series Missing Data Visualizations}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
--- 

但是,我的描述与您的描述略有不同:

描述

Suggests:
    testthat,  R.rsp, knitr, zoo, timeSeries, tis, xts, tibble, tsibble, rmarkdown
License: GPL-3
VignetteBuilder: R.rsp, knitr, rmarkdown

如您所见,rmarkdown 还额外添加为 VignetteBuilder。你能不能试试这个。一些 Github 问题也表明这可能与问题有关 (https://github.com/r-lib/usethis/issues/1147)