reformat_developing: Reformat file generated by use_r.function to developing...
In thmshrt/writethat: Provides CRAN Valid Documentation Templates
Description
Usage
Arguments
Examples
View source: R/reformat_developing.R
Description
Reformat file generated by use_r.function to developing structure
Usage
1
2
3
4
reformat_developing(
file_path,
dry_run = TRUE
)
Arguments
file_path
[character], length 1, file path to reformat
dry_run
[logical], length 1, if TRUE, print the reformatted file
Examples
1
2
3
4
5
6
7
8
9
#BEGIN: example
## Not run:
# observe that reformat_developing moves examples next to description
use_r.function('myfun.R')
reformat_packaging('myfun.R',dry_run=FALSE)
reformat_developing('myfun.R',dry_run=TRUE)
## End(Not run)
#END: example
thmshrt/writethat documentation built on Dec. 31, 2020, 8:37 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 Examples
View source: R/reformat_developing.R
Description
Reformat file generated by use_r.function to developing structure
Usage
1 2 3 4 | reformat_developing(
file_path,
dry_run = TRUE
)
|
Arguments
file_path |
[character], length 1, file path to reformat |
dry_run |
[logical], length 1, if TRUE, print the reformatted file |
Examples
1 2 3 4 5 6 7 8 9 | #BEGIN: example
## Not run:
# observe that reformat_developing moves examples next to description
use_r.function('myfun.R')
reformat_packaging('myfun.R',dry_run=FALSE)
reformat_developing('myfun.R',dry_run=TRUE)
## End(Not run)
#END: example
|
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.