updateReadme: Update the README file for the project
In bhuvad/restools: Research tools for data science projects
View source: R/update_readme.R
updateReadme R Documentation
Update the README file for the project
Description
Scans the project directory provided and creates entries for files in the
README.Rmd file. Descriptions of files can then be modified manually.
Usage
updateReadme(dsproj = ".")
Arguments
dsproj
a character, providing the path of the project where the file
needs to be updated.
Details
Only the description of files/directories should be modified in the
README.Rmd file. Modifying the comment tags or adding/removing text from the
file names will result in their removal in the next update.
Examples
## Not run:
# for "ds_project" in home folder
updateReadme('~/ds_project')
## End(Not run)
bhuvad/restools documentation built on June 16, 2024, 12:44 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/update_readme.R
| updateReadme | R Documentation |
Update the README file for the project
Description
Scans the project directory provided and creates entries for files in the README.Rmd file. Descriptions of files can then be modified manually.
Usage
updateReadme(dsproj = ".")
Arguments
dsproj |
a character, providing the path of the project where the file needs to be updated. |
Details
Only the description of files/directories should be modified in the README.Rmd file. Modifying the comment tags or adding/removing text from the file names will result in their removal in the next update.
Examples
## Not run:
# for "ds_project" in home folder
updateReadme('~/ds_project')
## End(Not run)
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.