README.md

intermediate_R

This temporary repository contains the files from the intermediate R workshop (Nov 2020). The file lm.function.R is already in the R/ directory. All of the necessary comments (preceded by #') have already been added to the file, including the @param, @importFrom, and @export, which are necessary to create the function's documentation and the NAMESPACE. The DESCRIPTION file already includes the necessary Imports (i.e., the packages that are required to run our function).

In order to create the package, you need to add the documentation (i.e., the NAMESPACE file and the help files inside man/). To do so, open the project and run devtools::document() in the console. After all documentation is created, you can build the package by going to Build > Load All. The package is now ready to use in your computer.

Finally, you can perform a check by running devtools::check() in the console. If you want to share your package with the world, you need to upload it to CRAN at: https://cran.r-project.org/submit.html



GilHenriques/intermediate_R documentation built on Dec. 31, 2020, 12:04 p.m.