pr_comment: Modifying the PR Comment
In lorenzwalthert/touchstone: Continuous Benchmarking with Statistical Confidence Based on 'Git' Branches
pr_comment R Documentation
Modifying the PR Comment
Description
The files touchstone/header.R and touchstone/footer.R allow you to modify
the PR comment. The files will be evaluated in the context of
benchmark_analyze() and should return one string containing the text.
You can use github markdown e.g. emojis like :tada: in the string.
Header
Available variables for glue substitution:
ci: confidence interval
branches: BASE and HEAD branches benchmarked against each other.
Footer
There are no special variables available in the footer.
You can access the benchmark results via path_pr_comment().
See Also
base::eval() base::parse()
lorenzwalthert/touchstone documentation built on April 20, 2024, 9:57 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| pr_comment | R Documentation |
Modifying the PR Comment
Description
The files touchstone/header.R and touchstone/footer.R allow you to modify
the PR comment. The files will be evaluated in the context of
benchmark_analyze() and should return one string containing the text.
You can use github markdown e.g. emojis like :tada: in the string.
Header
Available variables for glue substitution:
ci: confidence interval
branches: BASE and HEAD branches benchmarked against each other.
Footer
There are no special variables available in the footer.
You can access the benchmark results via path_pr_comment().
See Also
base::eval() base::parse()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.