写R包的长篇使用文档vignette

花花写于2020-3-20 公司的第二期线上培训,我的部分还剩明天最后一次课,讲完又能休息一周。不过由于要增加数据挖掘线上新课,下周要做研发。剧透一下,线上的数据挖掘课要加上TCGA了,我表示鸭梨山大。

从使用者的角度,调用长篇使用文档用browseVignettes函数,比如:

browseVignettes("clusterProfiler")

从开发这的角度,创建这个文档,书中写的非常简单:
使用devtools::use_vignette("my-vignette")命令,即可生成指南的模板,为rmd格式。
修改文档后,和其他rmd文档一样,用knit预览即可。
但在使用过程中出现了问题:

devtools::use_vignette("my-vignette")
Error: 'use_vignette' is not an exported object from 'namespace:devtools'

这就很尴尬了,书上的原文出了问题,这可咋整。
根据报错信息,这个就约等于“找不到函数”,所以看了一下包里的函数,这个use_vignette是真的没有。

书和包都是hadlay写的,绝不会有错,这就说明devtools更新了,这个函数过时了。

寻找替代函数

我想到,可能是这个函数被替代了吧,所以搜一下有没有其他的含有vignette的函数:

x = ls("package:devtools")
> library(devtools)
> library(stringr)
> str_subset(x,"vignette")
[1] "build_vignettes" "clean_vignettes"

只有 "build_vignettes" "clean_vignettes"这两个,研究了一下 "build_vignettes" ,好像并不是use_vignettes的替代。

所以现在问题就是,找到含有这个函数的devtools版本,并且安装这个历史版本的包。

寻找历史版本

搜索devtools::use_vignette() deprecated,找到了这个链接:https://cran.r-project.org/web/packages/devtools/news/news.html


后来发现,这个函数在1.6版本中出现(2014年),2.1.0版本中被删掉了,19年7月更新的,而R包开发这本书写的时间比这早。

安装历史版本

搜索install.packages old version,找到了这个链接:
https://support.rstudio.com/hc/en-us/articles/219949047-Installing-older-versions-of-packages

其中给出了历史版本存放的位置,从中可以找到devtools:
https://cran.r-project.org/src/contrib/Archive/devtools/
从上面的链接里找到安装代码,替换一下链接就可以安装2.1.0的上一个版本,2.0.2就可以。

packageurl <- "https://cran.r-project.org/src/contrib/Archive/devtools/devtools_2.0.2.tar.gz"
install.packages(packageurl, repos=NULL, type="source")

然后就可以用了,费了一番功夫,不过也学到了一点新知识,即安装历史版本的R包。
书中后续都是在介绍rmarkdown的语法,那些我都会了,就不写了。

花花写于2020-3-20 公司的第二期线上培训,我的部分还剩明天最后一次课,讲完又能休息一周。不过由于要增加数据挖掘线上新课,下周要做研发。剧透一下,线上的数据挖掘课要加上TCGA了,我表示鸭梨山大。

从使用者的角度,调用长篇使用文档用browseVignettes函数,比如:

browseVignettes("clusterProfiler")

从开发这的角度,创建这个文档,书中写的非常简单:
使用devtools::use_vignette("my-vignette")命令,即可生成指南的模板,为rmd格式。
修改文档后,和其他rmd文档一样,用knit预览即可。
但在使用过程中出现了问题:

devtools::use_vignette("my-vignette")
Error: 'use_vignette' is not an exported object from 'namespace:devtools'

这就很尴尬了,书上的原文出了问题,这可咋整。
根据报错信息,这个就约等于“找不到函数”,所以看了一下包里的函数,这个use_vignette是真的没有。

书和包都是hadlay写的,绝不会有错,这就说明devtools更新了,这个函数过时了。

寻找替代函数

我想到,可能是这个函数被替代了吧,所以搜一下有没有其他的含有vignette的函数:

x = ls("package:devtools")
> library(devtools)
> library(stringr)
> str_subset(x,"vignette")
[1] "build_vignettes" "clean_vignettes"

只有 "build_vignettes" "clean_vignettes"这两个,研究了一下 "build_vignettes" ,好像并不是use_vignettes的替代。

所以现在问题就是,找到含有这个函数的devtools版本,并且安装这个历史版本的包。

寻找历史版本

搜索devtools::use_vignette() deprecated,找到了这个链接:https://cran.r-project.org/web/packages/devtools/news/news.html


后来发现,这个函数在1.6版本中出现(2014年),2.1.0版本中被删掉了,19年7月更新的,而R包开发这本书写的时间比这早。

安装历史版本

搜索install.packages old version,找到了这个链接:
https://support.rstudio.com/hc/en-us/articles/219949047-Installing-older-versions-of-packages

其中给出了历史版本存放的位置,从中可以找到devtools:
https://cran.r-project.org/src/contrib/Archive/devtools/
从上面的链接里找到安装代码,替换一下链接就可以安装2.1.0的上一个版本,2.0.2就可以。

packageurl <- "https://cran.r-project.org/src/contrib/Archive/devtools/devtools_2.0.2.tar.gz"
install.packages(packageurl, repos=NULL, type="source")

然后就可以用了,费了一番功夫,不过也学到了一点新知识,即安装历史版本的R包。
书中后续都是在介绍rmarkdown的语法,那些我都会了,就不写了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,529评论 5 475
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,015评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,409评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,385评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,387评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,466评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,880评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,528评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,727评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,528评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,602评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,302评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,873评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,890评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,132评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,777评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,310评论 2 342

推荐阅读更多精彩内容