是否可以在github上为R代码放置一个显示输出的自述文件？

最近，我参加了由Siraj Raval发起的Linkedin上的100天MLCode挑战赛。我所有的代码都是用R编写的，但是当我在Github上为我的rcode推一个RMarkdown文件或readme文件时，它不会显示代码生成的输出。这使得观众很难理解解释。有没有一种方法可以显示代码和输出，以便读者更容易理解？我知道他们可以从github中提取我所做的更改，并在本地机器上查看它们。但是考虑到每个人都有时间限制，我仍然想知道是否有一种方法可以在github上的自述文件中显示Rcode和输出

---

谢谢

在标记中，您使用``表示内联代码，使用```表示代码块（多行）

GitHub只是一个服务器，它无法处理您的标记文件。两种战略是：

调用文件

README.Rmd

，并对其运行

render（）

，以生成包含输出的

README.md

文件，并将两者推送到GitHub

设置一个像这样的持续集成服务，并指示它呈现自述文件并将结果推回到GitHub

从技术设置的角度来看，第一个选项最简单-您只需

render（）

第二个选项更方便，但需要在repo中进行一些设置，将Travis配置为构建（但不是在其自己的提交上构建），并在Travis上设置凭据以执行回推到GitHub的操作。要执行此操作，您需要一个

.travis.yml

文件，该文件类似于：

language: r
script:
  - bash renderreadme.sh

以及repo中名为

renderreadme.sh

的bash脚本文件：

#!/bin/bash
set -o errexit -o nounset
renderreadme(){
  ## Set up Repo parameters
  git init
  git config user.name "your_github_username"
  git config user.email "your_email@example.com"
  git config --global push.default simple

  ## Get drat repo
  git remote add upstream "https://$GH_TOKEN@github.com/$TRAVIS_REPO_SLUG.git"
  git fetch upstream
  git checkout master

  Rscript -e 'rmarkdown::render("README.Rmd")'

  git add README.md
  git commit -m "knit README [skip ci]"
  git push
}
renderreadme

---

您需要使用（或类似的东西）来存储脚本中的

git push

操作成功所需的安全GitHub凭据。Travis中的一般指导对于这些一般配置方面很有用。

在yaml中，而不是使用

output:html\u文档

使用

output:github\u文档

。当你编织时，你会得到一份文档。或者更好的是，尝试一下

blogdown

，建立你自己的博客，并将其放在githup页面或netlify上。谢谢你，卡米尔，我也尝试过你的方法，但当我将更改推到github repo上时，它们仍然没有显示输出，但是如果您使用

output:rmarkdown:：github\u文档

，那么它就工作了。不知道为什么，但还是谢谢你。还有张TC，我正在考虑建立我自己的blow，所以，我一定会尝试你的建议。非常感谢。谢谢，你好。我想你误判了我的问题。编写标记文件时没有问题，只是当我在github上推送自述文件时，它只显示代码，但不显示代码生成的输出。不过，感谢您的响应。