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

Question

Recently I participated in the #100daysofmlcode challenge on Linkedin, started by Siraj Raval. I do all of my coding in R. But when I push an RMarkdown file or readme file for my rcode, on Github, it doesn't show the output generated from the code. This makes it really difficult for viewers to catch up with the explanation. Is there a way we could display the code and output, so that it becomes easier for readers to understand? I know they can pull the changes I make from github and see them on their local machines. But considering the time limitations that everyone has, I would still like to know if there is a way we can display both Rcode and output in a readme file on github.

Thank you

Answer 1

在markdown中，对内联代码使用``，对代码块（多行）使用``````

Answer 2

GitHub is just a server, it can't process your Rmarkdown file. Two strategies are:

1. Call your file README.Rmd , and run render() on it to generate a README.md file that contains the output and push both to GitHub.
2. Setup a continuous integration service like Travis-CI and instruct it to render your README and push the result back to GitHub.

The first option is easiest from a technical setup perspective - you just have to render() .

The second option is more convenient but requires some setup in your repo, configuring Travis to build (but not build on its own commits), and setting up credentials on Travis to do the push back to GitHub. To do this you'll need a .travis.yml file that looks something like:

language: r
script:
  - bash renderreadme.sh

And a bash script file in your repo called renderreadme.sh :

#!/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

And you'll need to use the travis client (or something equivalent) to store the secure GitHub credentials needed for the git push operation in that script to succeed. The general guidance in "Building an R Project" for Travis will be useful for these general configuration aspects.