From 12492182a6fab5fcc74333e1fcc6dc111c5151fc Mon Sep 17 00:00:00 2001 From: hrbrmstr Date: Fri, 7 Sep 2018 15:54:51 -0400 Subject: [PATCH] R package repo initialization complete --- .Rbuildignore | 13 +++++++++++++ .codecov.yml | 1 + .gitignore | 8 ++++++++ .travis.yml | 6 ++++++ DESCRIPTION | 24 ++++++++++++++++++++++++ NAMESPACE | 4 ++++ NEWS.md | 2 ++ R/zdnsr-package.R | 12 ++++++++++++ README.Rmd | 32 ++++++++++++++++++++++++++++++++ man/zdnsr.Rd | 16 ++++++++++++++++ tests/test-all.R | 2 ++ tests/testthat/test-zdnsr.R | 6 ++++++ zdnsr.Rproj | 21 +++++++++++++++++++++ 13 files changed, 147 insertions(+) create mode 100644 .Rbuildignore create mode 100644 .codecov.yml create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 DESCRIPTION create mode 100644 NAMESPACE create mode 100644 NEWS.md create mode 100644 R/zdnsr-package.R create mode 100644 README.Rmd create mode 100644 man/zdnsr.Rd create mode 100644 tests/test-all.R create mode 100644 tests/testthat/test-zdnsr.R create mode 100644 zdnsr.Rproj diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..451a4dd --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,13 @@ +^.*\.Rproj$ +^\.Rproj\.user$ +^\.travis\.yml$ +^README\.*Rmd$ +^README\.*html$ +^NOTES\.*Rmd$ +^NOTES\.*html$ +^\.codecov\.yml$ +^README_files$ +^doc$ +^tmp$ +^notes$ +^\.gitlab-ci\.yml$ diff --git a/.codecov.yml b/.codecov.yml new file mode 100644 index 0000000..69cb760 --- /dev/null +++ b/.codecov.yml @@ -0,0 +1 @@ +comment: false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cce1f17 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.DS_Store +.Rproj.user +.Rhistory +.RData +.Rproj +src/*.o +src/*.so +src/*.dll diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..f93993f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,6 @@ +language: R +sudo: false +cache: packages + +after_success: +- Rscript -e 'covr::codecov()' diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..af2af0a --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,24 @@ +Package: zdnsr +Type: Package +Title: zdnsr title goes here otherwise CRAN checks fail +Version: 0.1.0 +Date: 2018-09-07 +Authors@R: c( + person("Bob", "Rudis", email = "bob@rud.is", role = c("aut", "cre"), + comment = c(ORCID = "0000-0001-5670-2640")) + ) +Maintainer: Bob Rudis +Description: A good description goes here otherwise CRAN checks fail. +URL: https://gitlab.com/hrbrmstr/zdnsr +BugReports: https://gitlab.com/hrbrmstr/zdnsr/issues +Encoding: UTF-8 +License: AGPL +Suggests: + testthat, + covr +Depends: + R (>= 3.2.0) +Imports: + httr, + jsonlite +RoxygenNote: 6.0.1.9000 diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 0000000..5b4b9ae --- /dev/null +++ b/NAMESPACE @@ -0,0 +1,4 @@ +# Generated by roxygen2: do not edit by hand + +import(httr) +importFrom(jsonlite,fromJSON) diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..9b4679b --- /dev/null +++ b/NEWS.md @@ -0,0 +1,2 @@ +0.1.0 +* Initial release diff --git a/R/zdnsr-package.R b/R/zdnsr-package.R new file mode 100644 index 0000000..e4ec239 --- /dev/null +++ b/R/zdnsr-package.R @@ -0,0 +1,12 @@ +#' ... +#' +#' - URL: +#' - BugReports: +#' +#' @md +#' @name zdnsr +#' @docType package +#' @author Bob Rudis (bob@@rud.is) +#' @import httr +#' @importFrom jsonlite fromJSON +NULL diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000..996260b --- /dev/null +++ b/README.Rmd @@ -0,0 +1,32 @@ +--- +output: rmarkdown::github_document +--- + +# zdnsr + +## Description + +## What's Inside The Tin + +The following functions are implemented: + +## Installation + +```{r eval=FALSE} +devtools::install_github("hrbrmstr/zdnsr") +``` + +```{r message=FALSE, warning=FALSE, error=FALSE, include=FALSE} +options(width=120) +``` + +## Usage + +```{r message=FALSE, warning=FALSE, error=FALSE} +library(zdnsr) + +# current verison +packageVersion("zdnsr") + +``` + diff --git a/man/zdnsr.Rd b/man/zdnsr.Rd new file mode 100644 index 0000000..58fc0c6 --- /dev/null +++ b/man/zdnsr.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/zdnsr-package.R +\docType{package} +\name{zdnsr} +\alias{zdnsr} +\alias{zdnsr-package} +\title{...} +\description{ +\itemize{ +\item URL: \url{https://gitlab.com/hrbrmstr/zdnsr} +\item BugReports: \url{https://gitlab.com/hrbrmstr/zdnsr/issues} +} +} +\author{ +Bob Rudis (bob@rud.is) +} diff --git a/tests/test-all.R b/tests/test-all.R new file mode 100644 index 0000000..187c656 --- /dev/null +++ b/tests/test-all.R @@ -0,0 +1,2 @@ +library(testthat) +test_check("zdnsr") diff --git a/tests/testthat/test-zdnsr.R b/tests/testthat/test-zdnsr.R new file mode 100644 index 0000000..0c22968 --- /dev/null +++ b/tests/testthat/test-zdnsr.R @@ -0,0 +1,6 @@ +context("minimal package functionality") +test_that("we can do something", { + + #expect_that(some_function(), is_a("data.frame")) + +}) diff --git a/zdnsr.Rproj b/zdnsr.Rproj new file mode 100644 index 0000000..446d9e1 --- /dev/null +++ b/zdnsr.Rproj @@ -0,0 +1,21 @@ +Version: 1.0 + +RestoreWorkspace: Default +SaveWorkspace: Default +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX + +StripTrailingWhitespace: Yes + +BuildType: Package +PackageUseDevtools: Yes +PackageInstallArgs: --no-multiarch --with-keep.source +PackageBuildArgs: --resave-data +PackageRoxygenize: rd,collate,namespace