From 8d7b1d251249a908967f06e34acf56b1caac5d9e Mon Sep 17 00:00:00 2001 From: hrbrmstr Date: Thu, 6 Sep 2018 08:27:33 -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/psl-package.R | 12 ++++++++++++ README.Rmd | 32 ++++++++++++++++++++++++++++++++ man/psl.Rd | 16 ++++++++++++++++ psl.Rproj | 21 +++++++++++++++++++++ tests/test-all.R | 2 ++ tests/testthat/test-psl.R | 6 ++++++ 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/psl-package.R create mode 100644 README.Rmd create mode 100644 man/psl.Rd create mode 100644 psl.Rproj create mode 100644 tests/test-all.R create mode 100644 tests/testthat/test-psl.R 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..a5fb71a --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,24 @@ +Package: psl +Type: Package +Title: psl title goes here otherwise CRAN checks fail +Version: 0.1.0 +Date: 2018-09-06 +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/psl +BugReports: https://gitlab.com/hrbrmstr/psl/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/psl-package.R b/R/psl-package.R new file mode 100644 index 0000000..8b9c29b --- /dev/null +++ b/R/psl-package.R @@ -0,0 +1,12 @@ +#' ... +#' +#' - URL: +#' - BugReports: +#' +#' @md +#' @name psl +#' @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..7cc0969 --- /dev/null +++ b/README.Rmd @@ -0,0 +1,32 @@ +--- +output: rmarkdown::github_document +--- + +# psl + +## Description + +## What's Inside The Tin + +The following functions are implemented: + +## Installation + +```{r eval=FALSE} +devtools::install_github("hrbrmstr/psl") +``` + +```{r message=FALSE, warning=FALSE, error=FALSE, include=FALSE} +options(width=120) +``` + +## Usage + +```{r message=FALSE, warning=FALSE, error=FALSE} +library(psl) + +# current verison +packageVersion("psl") + +``` + diff --git a/man/psl.Rd b/man/psl.Rd new file mode 100644 index 0000000..3b917f8 --- /dev/null +++ b/man/psl.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/psl-package.R +\docType{package} +\name{psl} +\alias{psl} +\alias{psl-package} +\title{...} +\description{ +\itemize{ +\item URL: \url{https://gitlab.com/hrbrmstr/psl} +\item BugReports: \url{https://gitlab.com/hrbrmstr/psl/issues} +} +} +\author{ +Bob Rudis (bob@rud.is) +} diff --git a/psl.Rproj b/psl.Rproj new file mode 100644 index 0000000..446d9e1 --- /dev/null +++ b/psl.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 diff --git a/tests/test-all.R b/tests/test-all.R new file mode 100644 index 0000000..47846cf --- /dev/null +++ b/tests/test-all.R @@ -0,0 +1,2 @@ +library(testthat) +test_check("psl") diff --git a/tests/testthat/test-psl.R b/tests/testthat/test-psl.R new file mode 100644 index 0000000..0c22968 --- /dev/null +++ b/tests/testthat/test-psl.R @@ -0,0 +1,6 @@ +context("minimal package functionality") +test_that("we can do something", { + + #expect_that(some_function(), is_a("data.frame")) + +})