![](/img/trans.png)
[英]GitHub displays all code chunks from README.rmd (despite include=FALSE)
[英]Is it possible to put a readme file for R code on github, that displays output?
最近,我參加了Siraj Raval 發起的 Linkedin上的#100daysofmlcode挑戰。 我在R中進行所有編碼。但是,當我在Github上為我的rcode推送RMarkdown文件或自述文件時,它不會顯示從代碼生成的輸出。 這使得觀看者很難跟上解釋。 有沒有一種方法可以顯示代碼和輸出,從而使讀者更容易理解? 我知道他們可以從github提取我所做的更改,並在本地計算機上查看它們。 但是考慮到每個人的時間限制,我仍然想知道是否有一種方法可以在github上的自述文件中同時顯示Rcode和輸出。
謝謝
在markdown中,對內聯代碼使用``,對代碼塊(多行)使用``````
GitHub只是一台服務器,它無法處理您的Rmarkdown文件。 兩種策略是:
README.Rmd
,並在其上運行render()
以生成一個包含輸出的README.md
文件,並將兩者都推送到GitHub。 從技術設置的角度來看,第一個選項是最簡單的-您只需要render()
。
第二個選項更方便,但是需要在倉庫中進行一些設置,配置Travis進行構建(但不能基於自己的提交),並在Travis上設置憑據以將其推回GitHub。 為此,您需要一個看起來像如下的.travis.yml
文件:
language: r
script:
- bash renderreadme.sh
在您的存儲庫中有一個bash腳本文件,名為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
而且,您將需要使用travis客戶端 (或類似的客戶端 )來存儲git push
操作成功所需的安全GitHub憑據。 Travis的“構建R項目”中的常規指南對於這些常規配置方面將很有用。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.