如何在rmarkdown中打印git历史记录?

时间:2017-02-04 08:35:39

标签: r git knitr r-markdown

我正在用rmarkdown编写分析报告,并希望有一个“文档版本”部分,其中我将指出文档的不同版本以及所做的更改。

我没有手动写下来,而是考虑使用git历史记录并将其自动插入降价文档(在表格中格式化)。

我该怎么做?有可能吗?

2 个答案:

答案 0 :(得分:3)

安装git2rhttps://github.com/ropensci/git2r然后您可以执行以下操作:

> r = repository(".")
> cs = commits(r)
> cs[[1]]
[02cf9a0] 2017-02-02: uses Rcpp attributes instead of inline

所以现在我有一个关于这个repo的所有提交的列表。您可以根据自己的需要从每个提交中获取信息并将其格式化为文档。

> summary(cs[[1]])
Commit:  02cf9a0ff92d3f925b68853374640596530c90b5
Author:  barryrowlingson <b.rowlingson@gmail.com>
When:    2017-02-02 23:03:17

     uses Rcpp attributes instead of inline

11 files changed, 308 insertions, 151 deletions
DESCRIPTION           | -  0 +  2  in 2 hunks
NAMESPACE             | -  0 +  2  in 1 hunk
R/RcppExports.R       | -  0 + 23  in 1 hunk
R/auxfunctions.R      | -  1 +  1  in 1 hunk
R/skewt.r             | -  0 +  3  in 1 hunk
R/update_params.R     | -  1 +  1  in 1 hunk
R/update_params_cpp.R | -149 +  4  in 2 hunks
src/.gitignore        | -  0 +  3  in 1 hunk
src/RcppExports.cpp   | -  0 + 76  in 1 hunk
src/hello_world.cpp   | -  0 + 13  in 1 hunk
src/update_params.cpp | -  0 +180  in 1 hunk

因此,如果您只想要时间和提交消息,那么您可以从对象中获取它。

> cs[[3]]@message
[1] "fix imports etc\n"
> cs[[3]]@committer@when
2017-01-20 23:26:20

我不知道它们是否有适当的访问器功能,而不是使用@ -notation来获取插槽。需要多阅读文档......

您可以通过以下方式从提交中创建数据框:

> do.call(rbind,lapply(cs,function(cs){as(cs,"data.frame")}))

将日期转换为POSIXct对象,这很好。从数据框创建降价表应该是微不足道的!

答案 1 :(得分:2)

您可以使用pretty=format [1]

手动将git log转换为markdown

这样的东西
git log --reverse --pretty=format:'| %H | %s |'

这将输出如下内容:

| a8d5defb511f1e44ddea21b42aec9b03ee768253 | initial commit |
| fdd9865e9cf01bd53c4f1dc106ee603b0a730f48 | fix tests |
| 10b58e8dd9cf0b9bebbb520408f0b342df613627 | add Dockerfile |
| d039004e8073a20b5d6eab1979c1afa213b78fa3 | update README.md |

1:https://git-scm.com/docs/pretty-formats