add_readme: Add README file to an RO-Crate
In rocrateR: Tools for Creating and Manipulating RO-Crates
View source: R/utils-rocrate.R
add_readme R Documentation
Add README file to an RO-Crate
Description
Add README file to an RO-Crate
Usage
add_readme(rocrate, text, filename = "README.md")
Arguments
rocrate
RO-Crate object, see rocrate.
text
Character vector with README content.
filename
README filename.
Value
Updated RO-Crate object.
rocrateR documentation built on April 9, 2026, 1:06 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.
View source: R/utils-rocrate.R
| add_readme | R Documentation |
Add README file to an RO-Crate
Description
Add README file to an RO-Crate
Usage
add_readme(rocrate, text, filename = "README.md")
Arguments
rocrate |
RO-Crate object, see rocrate. |
text |
Character vector with README content. |
filename |
README filename. |
Value
Updated RO-Crate object.
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.