setup_readme: Setup README with Disclaimer in Project
In USAID-OHA-SI/glamr: SI Utilities Package
setup_readme R Documentation
Setup README with Disclaimer in Project
Description
'setup_readme()' establishes a README.md with the standard USAID disclaimer
(or appends to one that currently exists). This function can be used as a
stand alone function but primarily serves 'si_setup()'.
Usage
setup_readme(add_disclaimer = TRUE)
Arguments
add_disclaimer
should the standard disclaimer be added, default = TRUE
Value
adds/appends disclaimer to README
See Also
Other project setup:
folder_setup(),
setup_gitignore(),
si_setup()
Examples
## Not run:
#standard (appends dislaimer if README exists)
setup_readme()
## End(Not run)
USAID-OHA-SI/glamr documentation built on July 6, 2024, 6:39 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.
| setup_readme | R Documentation |
Setup README with Disclaimer in Project
Description
'setup_readme()' establishes a README.md with the standard USAID disclaimer (or appends to one that currently exists). This function can be used as a stand alone function but primarily serves 'si_setup()'.
Usage
setup_readme(add_disclaimer = TRUE)
Arguments
add_disclaimer |
should the standard disclaimer be added, default = TRUE |
Value
adds/appends disclaimer to README
See Also
Other project setup:
folder_setup(),
setup_gitignore(),
si_setup()
Examples
## Not run:
#standard (appends dislaimer if README exists)
setup_readme()
## 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.