btts: btts: We need to go... Back To The Source
In jonocarroll/btts: We need to go... Back To The Source
Description
Provides an Rmd macro to insert a HTML popup bar in the help menu linking
back to the GitHub page to encourage collaboration, report bugs, etc...
Details
The behaviour of install_github is otherwise identical to
the devtools version install_github except that some
HTML code is carefully inserted in the roxygen2 header. Processing of the
roxygen2 code into a .Rd help file is also hijacked and
HTML sanitisation is deactivated (for that call only). The injected HTML
(static, not user-changeable for now) overlays a pull-up tab at the bottom of
HTML help files (such as viewed in RStudio) with some context of the GitHub
package, such as links to the source, issues page, version, and author.
The code for *that* function is linked to in the GitHub repo, meaning you can
see exactly how the function was written, rather than the comment-lacking
body() from within R.
Noam Ross created https://github.com/noamross/htmlhelp which I adapted
into this form. This would not have been possible without his first steps.
jonocarroll/btts documentation built on May 24, 2019, 2:49 p.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.
Description
Provides an Rmd macro to insert a HTML popup bar in the help menu linking back to the GitHub page to encourage collaboration, report bugs, etc...
Details
The behaviour of install_github is otherwise identical to
the devtools version install_github except that some
HTML code is carefully inserted in the roxygen2 header. Processing of the
roxygen2 code into a .Rd help file is also hijacked and
HTML sanitisation is deactivated (for that call only). The injected HTML
(static, not user-changeable for now) overlays a pull-up tab at the bottom of
HTML help files (such as viewed in RStudio) with some context of the GitHub
package, such as links to the source, issues page, version, and author.
The code for *that* function is linked to in the GitHub repo, meaning you can see exactly how the function was written, rather than the comment-lacking body() from within R.
Noam Ross created https://github.com/noamross/htmlhelp which I adapted into this form. This would not have been possible without his first steps.
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.