From 66258a20d8575222bb7a2602ffb49b5861d61038 Mon Sep 17 00:00:00 2001 From: "B.Anderson" <ba1e12@srv02405.soton.ac.uk> Date: Sun, 17 May 2020 19:28:26 +0100 Subject: [PATCH] added example function (setup) and ran initial build --- .Rbuildignore | 2 ++ DESCRIPTION | 17 +++++++++++++++++ NAMESPACE | 3 +++ R/setup.R | 10 ++++++++++ man/setup.Rd | 14 ++++++++++++++ 5 files changed, 46 insertions(+) create mode 100644 .Rbuildignore create mode 100644 DESCRIPTION create mode 100644 NAMESPACE create mode 100644 R/setup.R create mode 100644 man/setup.Rd diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..91114bf --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,2 @@ +^.*\.Rproj$ +^\.Rproj\.user$ diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..cdcc7ae --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,17 @@ +Package: woRkflow +Type: Package +Title: A template for how we do collaborative reproducible analysis with R #ymmv +Version: 0.1.0 +Authors@R: + c(person(given = "Ben", + family = "Anderson", + role = c("aut", "cre"), + email = "ben.anderson@otago.ac.nz") + ) +Description: A repo that collects various guidance and resources for people trying to set up and run collaborative reproducible analysis with R. Also a repo that can act as a template for you if you like how we work. You may not... +License: MIT License +Imports: + here +Encoding: UTF-8 +LazyData: true +RoxygenNote: 7.1.0 \ No newline at end of file diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 0000000..c94578d --- /dev/null +++ b/NAMESPACE @@ -0,0 +1,3 @@ +# Generated by roxygen2: do not edit by hand + +export(setup) diff --git a/R/setup.R b/R/setup.R new file mode 100644 index 0000000..64b64b8 --- /dev/null +++ b/R/setup.R @@ -0,0 +1,10 @@ +#' Set up the project +#' +#' \code{setup} sources env.R in the repo/project top level folder. +#' +#' @author Ben Anderson, \email{b.anderson@@soton.ac.uk} +#' @export +#' +setup <- function() { + source(here::here("env.R")) +} \ No newline at end of file diff --git a/man/setup.Rd b/man/setup.Rd new file mode 100644 index 0000000..7107e05 --- /dev/null +++ b/man/setup.Rd @@ -0,0 +1,14 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/setup.R +\name{setup} +\alias{setup} +\title{Set up the project} +\usage{ +setup() +} +\description{ +\code{setup} sources env.R in the repo/project top level folder. +} +\author{ +Ben Anderson, \email{b.anderson@soton.ac.uk} +} -- GitLab