build_sweary: Automates sweary builds
In pdrhlik/sweary: Database of Swear Words in R
Description
Usage
Arguments
Value
Description
It starts with rebuilding the 'swear_words' data frame
by running a prepared script. It lists all language files
and constructs the data frame.
Then it rerenders the README.Rmd file so that all the proper
numbers of new words and languages propagate into README.md.
We also have to delete the README.html file that is created
in the process.
The next step is to create necesarry documentation from
roxygen comments.
Then we build the package as we would normally.
After a build, we run local tests that ensure our
raw files consistency and check that the data frame
'swear_words' has been modified accordingly.
The last step is a complex check.
Every error or warning should be properly addressed
before merging into master.
Usage
1
build_sweary(quiet = FALSE)
Arguments
quiet
If TRUE, stops printing most of the output.
Defaults to FALSE.
Value
Summary of the build process - list of class
sweary_build_results.
pdrhlik/sweary documentation built on May 8, 2019, 12:59 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.
Description Usage Arguments Value
Description
It starts with rebuilding the 'swear_words' data frame by running a prepared script. It lists all language files and constructs the data frame.
Then it rerenders the README.Rmd file so that all the proper numbers of new words and languages propagate into README.md. We also have to delete the README.html file that is created in the process.
The next step is to create necesarry documentation from roxygen comments.
Then we build the package as we would normally.
After a build, we run local tests that ensure our raw files consistency and check that the data frame 'swear_words' has been modified accordingly.
The last step is a complex check.
Every error or warning should be properly addressed before merging into master.
Usage
1 | build_sweary(quiet = FALSE)
|
Arguments
quiet |
If |
Value
Summary of the build process - list of class
sweary_build_results.
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.