Initial commit of R packaging-related files for dash-component-boilerplate

cookiecutter.json

@@ -5,6 +5,18 @@
   "author_name": "Enter your name (For package.json)",
   "author_email": "Enter your email (For package.json)",
   "description": "Project Description",
+  "github_username": "Enter the account name of the person or group who maintains the repo to which the package will be contributed.",
+  "repo_name": "Enter the name of the GitHub repository.", 
+  "r_package_name": "Enter the name of the R package to build.",
+  "r_project_title": "Enter a descriptive R package title.",
+  "r_package_version": "Enter an (integer/numeric) R package version.",
+  "r_package_prefix": "",
+  "r_package_description": "Enter a short R package description.",
+  "r_package_encoding": "UTF-8",
+  "r_package_depends": "",
+  "r_package_imports": "",
+  "r_package_suggests": "",
+  "r_package_lazydata": "true",
   "license": [
     "MIT License",
     "BSD License",
@@ -15,4 +27,4 @@
   ],
   "publish_on_npm": true,
   "install_dependencies": true
-}
+}

{{cookiecutter.project_shortname}}/DESCRIPTION

@@ -0,0 +1,14 @@
+Package: {{ cookiecutter.r_package_name }}
+Title: {{ cookiecutter.r_project_title }}
+Version: {{ cookiecutter.r_package_version }}
+Maintainer: {{ cookiecutter.full_name}} <{{ cookiecutter.author_email }}>
+Description: {{ cookiecutter.r_package_description }}
+Authors @R: as.personi(c({{ cookiecutter.author_name }}))
+Depends: {{ cookiecutter.r_package_depends }}
+Imports: {{ cookiecutter.r_package_imports }}
+Suggests: {{ cookiecutter.r_package_suggests }}
+License: {{ cookiecutter.license }}
+Encoding: {{ cookiecutter.r_package_encoding }}
+LazyData: {{ cookiecutter.r_package_lazydata }} 
+URL: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_shortname }}
+BugReports: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_shortname }}/issues

{{cookiecutter.project_shortname}}/NAMESPACE

@@ -0,0 +1,10 @@
+# List the R functions to be exported here
+# To export one function called "somefunction", use
+#    export(somefunction)
+#
+# To export all functions which don't start with a dot, use
+#    exportPattern("^[^\\.]")
+#
+# It's generally preferable to export functions as needed, however.
+#    https://cran.r-project.org/doc/manuals/r-release/R-exts.html
+#    http://r-pkgs.had.co.nz/namespace.html

{{cookiecutter.project_shortname}}/R/{{ cookiecutter.r_package_name }}.R

@@ -0,0 +1,22 @@
+#' {{ cookiecutter.project_short_description }}
+#'
+#' @docType package
+#' @name {{ cookiecutter.r_package_name }}
+#
+# Write functions only and document them with roxygen-styled comments.
+# Example below taken from http://r-pkgs.had.co.nz/man.html
+#
+
+#' Add together two numbers.
+#' 
+#' @param x A number.
+#' @param y A number.
+#' @return The sum of \code{x} and \code{y}.
+#' @examples
+#' add(1, 1)
+#' add(10, 1)
+#' @export
+add <- function(x, y) {
+      x + y
+}
+

{{cookiecutter.project_shortname}}/man/add.Rd

@@ -0,0 +1,22 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
+\name{add}
+\alias{add}
+\title{Add together two numbers}
+\usage{
+add(x, y)
+}
+\arguments{
+  \item{x}{A number}
+
+  \item{y}{A number}
+}
+\value{
+The sum of \code{x} and \code{y}
+}
+\description{
+Add together two numbers
+}
+\examples{
+add(1, 1)
+add(10, 1)
+}

{{cookiecutter.project_shortname}}/package.json

@@ -10,8 +10,9 @@
     "build:js-dev": "webpack --mode development",
     "build:js": "webpack --mode production",
     "build:py": "dash-generate-components ./src/lib/components {{ cookiecutter.project_shortname }}",
+    "build:r": "dash-generate-components ./src/lib/components {{ cookiecutter.project_shortname }} --r-prefix '{{ cookiecutter.r_package_prefix }}'",
     "build:py-activated": "(. venv/bin/activate || venv\\scripts\\activate && npm run build:py)",
-    "build:all": "npm run build:js && npm run build:js-dev && npm run build:py",
+    "build:all": "npm run build:js && npm run build:js-dev && npm run build:py && npm run build:r",
     "build:all-activated": "(. venv/bin/activate || venv\\scripts\\activate && npm run build:all)"
   },
   "author": "{{ cookiecutter.author_name }} {{ cookiecutter.author_email }}",