add_badge_comments: Add special marker comments delimiting the badge section of...
In jefferis/nat.devtools: Tools to help develop natverse packages
Description
Usage
Arguments
Details
Value
See Also
Description
Add special marker comments delimiting the badge section of package README
Usage
1
add_badge_comments(x = "README.md", f = NULL)
Arguments
x
Name of README file
f
Absolute path to file (can be used instead of x for
debugging)
Details
Badge comment lines are required for
usethis::use_badge and friends to automagically add badges to
a README.
add_badge_comments will only add badge comments if they are not yet
present. If there are some badges present then will add marker comments on
either side. Will give a warning and do nothing if badge lines are not
contiguous
Value
Path to modified readme file (invisibly)
See Also
natverse-badges, usethis::use_badge
jefferis/nat.devtools documentation built on July 10, 2021, 12:07 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 Usage Arguments Details Value See Also
Description
Add special marker comments delimiting the badge section of package README
Usage
1 | add_badge_comments(x = "README.md", f = NULL)
|
Arguments
x |
Name of README file |
f |
Absolute path to file (can be used instead of |
Details
Badge comment lines are required for
usethis::use_badge and friends to automagically add badges to
a README.
add_badge_comments will only add badge comments if they are not yet
present. If there are some badges present then will add marker comments on
either side. Will give a warning and do nothing if badge lines are not
contiguous
Value
Path to modified readme file (invisibly)
See Also
natverse-badges, usethis::use_badge
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.