add basic comments to document each function

Author: expectopatronum

.gitignore

@@ -4,34 +4,26 @@
 
 # Session Data files
 .RData
-
 # Example code in package build process
 *-Ex.R
-
 # Output files from R CMD build
 /*.tar.gz
-
 # Output files from R CMD check
 /*.Rcheck/
-
 # RStudio files
 .Rproj.user/
-
 # produced vignettes
 vignettes/*.html
 vignettes/*.pdf
-
 # OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
 .httr-oauth
-
 # knitr and R markdown default cache directories
 /*_cache/
 /cache/
-
 # Temporary files created by R markdown
 *.utf8.md
 *.knit.md
-
 # Shiny token, see https://shiny.rstudio.com/articles/shinyapps.html
 rsconnect/
 .Rproj.user
+inst/doc

DESCRIPTION

@@ -8,4 +8,8 @@ Description: More about what it does (maybe more than one line)
     Use four spaces when indenting paragraphs within the Description.
 License: What license is it under?
 Encoding: UTF-8
-LazyData: true
+LazyData: true
+RoxygenNote: 6.0.1
+Suggests: knitr,
+    rmarkdown
+VignetteBuilder: knitr

NAMESPACE

@@ -1 +1,10 @@
-exportPattern("^[[:alpha:]]+")
+# Generated by roxygen2: do not edit by hand
+
+export(cast_dice)
+export(d10)
+export(d100)
+export(d20)
+export(d4)
+export(d6)
+export(d8)
+export(sicherman)

R/dice.R

@@ -1,3 +1,15 @@
+#' Cast a dice
+#'
+#' @param sides can either be an integer value (maximum value on a standard dice) or a vector of sides.
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @examples
+#' cast_dice()
+#' cast_dice(5)
+#' cast_dice(1:5) # same as example above
+#' cast_dice(20, 3)
+#' cast_dice(20, 3, TRUE)
+#' @export
 cast_dice <- function(sides = 1:6, n_tries = 1, sum = FALSE) {
   result <- sample(sides, n_tries, TRUE)
   if (sum) {

R/dnd_dice.R

@@ -1,23 +1,53 @@
+#' Cast a D4
+#'
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @export
 d4 <- function(n_tries = 1, sum = FALSE) {
   return(cast_dice(4, n_tries, sum))
 }
 
+#' Cast a D6
+#'
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @export
 d6 <- function(n_tries = 1, sum = FALSE) {
   return(cast_dice(6, n_tries, sum))
 }
 
+#' Cast a D8
+#'
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @export
 d8 <- function(n_tries = 1, sum = FALSE) {
   return(cast_dice(8, n_tries, sum))
 }
 
+#' Cast a D10
+#'
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @export
 d10 <- function(n_tries = 1, sum = FALSE) {
   return(cast_dice(10, n_tries, sum))
 }
 
+#' Cast a D20
+#'
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @export
 d20 <- function(n_tries = 1, sum = FALSE) {
   return(cast_dice(20, n_tries, sum))
 }
 
+#' Cast a D100
+#'
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @export
 d100 <- function(n_tries = 1, sum = FALSE) {
   return(cast_dice(100, n_tries, sum))
 }

R/special_dice.R

@@ -1,3 +1,8 @@
+#' Cast a Sicherman dice
+#'
+#' @param n_tries how often the dice should be cast.
+#' @param sum whether the result of casting the dice should be summed.
+#' @export
 sicherman <- function(n_tries=1, sum = FALSE) {
   s1 <- .sicherman1(n_tries)
   s2 <- .sicherman2(n_tries)