写教程常用的RMarkdown设置

刚开始写教程时,RMarkdown给我带来很大阻碍,而且排版不好,老板也看不下去,于是整理整理,这个成了我写教程时一直用的排版:

title: "系列名称--包名称(必学bioconductor包300个)+编号"
toc是方便写长文档时的导航目录:

title: "R包简介--BSgenome(必学bioconductor包300个)(1)" 
author: "DongQing"
date: "2020/4/5"
output: 
  html_document:
    toc: true
    toc_float: true

对于代码块的整体设置:

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
knitr::opts_chunk$set(fig.width = 6, collapse = TRUE)
knitr::opts_chunk$set(echo = TRUE)
knitr::opts_chunk$set(error = TRUE)
knitr::opts_chunk$set(warning = F)
knitr::opts_chunk$set(message  = F)
---
title: "xxxx"
author: "xxx"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Vignette Title}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
knitr::opts_chunk$set(fig.width = 7, fig.height = 5,collapse = TRUE)
knitr::opts_chunk$set(message = FALSE)

又看到更新了~~~

title: "xxxx"
author: "xxx"
date: "`r format(Sys.time(), '%d %B, %Y')`"
output: 
  html_document: 
    highlight: haddock
    toc: yes
    toc_depth: 6
    toc_float: yes

如果这部分代码不想运行,那些运行特别耗时间的记得在教程中提醒:

{r eval=FALSE}

如果分节,
第一节开头:是总括和简介,一般已经写好,直接copy-paste;
第一节结尾:小结:本节介绍了包的基本和主要的用法,如xxx包比较重要和常用的内容就讲解完成了,还有补充内容请见第(2)部分~
第二节开头:我们在R包简介--xxx包(必学bioconductor包300个)(1)中介绍了xxxx基础操作,接下来介绍xxxxx的用法。
第二节结尾: xxx的用法和实例已经讲解完了,生物信息学论坛上都在讨论的热点问题,请见第(3)部分~
第三节开头:xxx包总结来说,用法要掌握xxx。

最后一定要附上会话文件

sessionInfo() # 查看编译此文档的系统上的输出
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • R语言包的安装 参考文章 在R中大概有几种包的安装方式。 install.packages()常规包的安装 括号里...
    天涯清水阅读 14,101评论 0 22
  • 在学习R的时候,R的包众多,很多时候对于初学者会造成很大的困扰就是不知道用什么样的包比较合适。我会在不断使用...
    果果哥哥BBQ阅读 16,173评论 0 62
  • 马云在2017新乡村校长领导力课堂上,面对在坐的乡村校长进行了长达1个小时的分享。 马云认为:中国...
    河北南和刘志玉阅读 414评论 1 2
  • 先说朱佑樘,历史上评价极高,作者也给与了极高的评价,是个好人,也是个好皇帝,实行一夫一妻制,只有朱厚照一个宝贝儿子...
    诺克萨斯即将崛起阅读 260评论 0 1
  • 斯德哥尔摩综合征,斯德哥尔摩效应,又称斯德哥尔摩症候群或者称为人质情结或人质综合征,是指被害者对于犯罪者产生情感,...
    妈妈熊阅读 522评论 0 1