remove 'Read-and-delete-me'; add documentation to vector-sum.cpp

Author: kevinushey

R/skeleton.R

@@ -23,6 +23,7 @@ RcppParallel.package.skeleton <- function(name = "anRpackage",
    # remove dummy stuff
    unlink("data/dummy.Rda")
    unlink("man/dummy.Rd")
+   unlink("Read-and-delete-me")
 
    message("\nAdding RcppParallel settings")
 
@@ -94,4 +95,4 @@ RcppParallel.package.skeleton <- function(name = "anRpackage",
    }
 
    TRUE
-}
+}

inst/rstudio/templates/project/RcppParallel.package.skeleton.dcf

@@ -2,7 +2,7 @@ Binding: RcppParallel.package.skeleton
 Title: R Package using RcppParallel
 Subtitle: Create a new R Package using RcppParallel
 Caption: Create R Package using RcppParallel
-OpenFiles: Read-and-delete-me, src/vector-sum.cpp
+OpenFiles: src/vector-sum.cpp
 
 Parameter: example_code
 Widget: CheckboxInput

inst/skeleton/vector-sum.cpp

@@ -1,3 +1,16 @@
+/**
+ *
+ * This file contains example code showcasing how RcppParallel
+ * can be used. In this file, we define and export a function called
+ * 'parallelVectorSum()', which computes the sum of a numeric vector
+ * in parallel.
+ *
+ * Please see https://rcppcore.github.io/RcppParallel/ for more
+ * details on how to use RcppParallel in an R package, and the
+ * Rcpp gallery at http://gallery.rcpp.org/ for more examples.
+ *
+ */
+
 // [[Rcpp::depends(RcppParallel)]]
 #include <Rcpp.h>
 #include <RcppParallel.h>