====== How to create an R package using R Studio ======

Creating a basic R package is quite simple. However, to keep it handy, you should the roxygen2 package for handling the documentation (which is why the headers in the files below start with "#'"). Here's a short overview on how to start:

  - Create a new empty package using ''File > New Project > New Directory > R Package'' and fill in the details
  - In the standard upper left window region, go to the ''Build'' tab and then on ''More > Configure Built''. Mark "Generate documentation with Roxygen" and press the ''Configure'' button afterwards to additionally mark the line called "NAMESACE file".
  - Delete the file called NAMESPACE in the root directory of your freshly created project (this file will be created by roxygen later).
  - Adapt your main R package file (which is called after the package). In the end it should look like the template below.
  - Add at least one additional function to your package and include a header like the one in the template below (the "@@" in the e-mail are mandatory!)
  - When everything is done, go to the ''Build'' tab again and click on ''More > Document'' to generate the documentation files. Click on ''Clean and Rebuild'' in the same drop down menu afterwards.

For more information have a look at these how-tos on [[https://support.rstudio.com/hc/en-us/articles/200486488-Developing-Packages-with-RStudio|creating R Packages]], [[https://support.rstudio.com/hc/en-us/articles/200532317-Writing-Package-Documentation|writing documentation]] and [[http://r-pkgs.had.co.nz/|R packages]] in general.

<file rsplus| Template for main R Package file>
#' One line information
#'
#' A view lines describing the package in more 
#' detail.
#'
#' @name Name of the package
#' @aliases Short name of the package
#' @docType package
#' @title Title of the package
#' @author name of the author(s)\cr
#' \cr
#' \emph{Maintainer:} Maintainer of the package \email{maintainer@@some-email.de}
#'
#' @keywords package
#'
NULL
</file>

<file rsplus| Template file for function headers>
#' One line description
#'
#' @description
#' More detailed, multi-line
#' description.
#'
#' @param example1 some parameter of the function
#' @param example2 some other parameter of the function
#'
#' @return what the function does return
#'
#' @export nameOfTheFunction
#'
#' @examples
#' not run:
#' nameOfTheFunction(example1= "X", example2 = 5)
nameOfTheFunction <- function(...){...}
</file>