From e7cfa03d87efdfe522f0d889f9e8e768713f0901 Mon Sep 17 00:00:00 2001 From: boB Rudis Date: Sat, 25 May 2019 17:06:11 -0400 Subject: [PATCH] R package repo initialization complete --- .Rbuildignore | 15 +++++++++++++ .codecov.yml | 1 + .gitignore | 9 ++++++++ .travis.yml | 6 +++++ CONDUCT.md | 25 +++++++++++++++++++++ DESCRIPTION | 25 +++++++++++++++++++++ NAMESPACE | 4 ++++ NEWS.md | 2 ++ R/playdoh-package.R | 12 ++++++++++ README.Rmd | 52 +++++++++++++++++++++++++++++++++++++++++++ man/playdoh.Rd | 16 +++++++++++++ playdoh.Rproj | 21 +++++++++++++++++ tests/test-all.R | 2 ++ tests/testthat/test-playdoh.R | 6 +++++ 14 files changed, 196 insertions(+) create mode 100644 .Rbuildignore create mode 100644 .codecov.yml create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 CONDUCT.md create mode 100644 DESCRIPTION create mode 100644 NAMESPACE create mode 100644 NEWS.md create mode 100644 R/playdoh-package.R create mode 100644 README.Rmd create mode 100644 man/playdoh.Rd create mode 100644 playdoh.Rproj create mode 100644 tests/test-all.R create mode 100644 tests/testthat/test-playdoh.R diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..ece4c73 --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,15 @@ +^.vscode$ +^.*\.Rproj$ +^\.Rproj\.user$ +^\.travis\.yml$ +^README\.*Rmd$ +^README\.*html$ +^NOTES\.*Rmd$ +^NOTES\.*html$ +^\.codecov\.yml$ +^README_files$ +^doc$ +^docs$ +^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..accfbc6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.DS_Store +.Rproj.user +.Rhistory +.RData +.Rproj +README_cache +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/CONDUCT.md b/CONDUCT.md new file mode 100644 index 0000000..52a673e --- /dev/null +++ b/CONDUCT.md @@ -0,0 +1,25 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, we pledge to respect all people who +contribute through reporting issues, posting feature requests, updating documentation, +submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for +everyone, regardless of level of experience, gender, gender identity and expression, +sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. + +Examples of unacceptable behavior by participants include the use of sexual language or +imagery, derogatory comments or personal attacks, trolling, public or private harassment, +insults, or other unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, +commits, code, wiki edits, issues, and other contributions that are not aligned to this +Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed +from the project team. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by +opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the Contributor Covenant +(http:contributor-covenant.org), version 1.0.0, available at +http://contributor-covenant.org/version/1/0/0/ diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..950121b --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,25 @@ +Package: playdoh +Type: Package +Title: playdoh title goes here otherwise CRAN checks fail +Version: 0.1.0 +Date: 2019-05-25 +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/playdoh +BugReports: https://gitlab.com/hrbrmstr/playdoh/issues +Encoding: UTF-8 +License: AGPL +Suggests: + testthat, + covr +Depends: + R (>= 3.2.0) +Imports: + httr, + jsonlite +Roxygen: list(markdown = TRUE) +RoxygenNote: 6.1.1 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/playdoh-package.R b/R/playdoh-package.R new file mode 100644 index 0000000..7390109 --- /dev/null +++ b/R/playdoh-package.R @@ -0,0 +1,12 @@ +#' ... +#' +#' - URL: +#' - BugReports: +#' +#' @md +#' @name playdoh +#' @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..425063e --- /dev/null +++ b/README.Rmd @@ -0,0 +1,52 @@ +--- +output: rmarkdown::github_document +editor_options: + chunk_output_type: inline +--- +```{r pkg-knitr-opts, include=FALSE} +knitr::opts_chunk$set(collapse=TRUE, fig.retina=2, message=FALSE, warning=FALSE) +options(width=120) +``` + +[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/playdoh.svg?branch=master)](https://travis-ci.org/hrbrmstr/playdoh) +[![Coverage Status](https://codecov.io/gh/hrbrmstr/playdoh/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/playdoh) +[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/playdoh)](https://cran.r-project.org/package=playdoh) + +# playdoh + +## Description + +## What's Inside The Tin + +The following functions are implemented: + +## Installation + +```{r install-ex, eval=FALSE} +devtools::install_git("https://sr.ht.com/~hrbrmstr/playdoh.git") +# or +devtools::install_git("https://gitlab.com/hrbrmstr/playdoh.git") +# or (if you must) +devtools::install_github("hrbrmstr/playdoh") +``` + +## Usage + +```{r lib-ex} +library(playdoh) + +# current version +packageVersion("playdoh") + +``` + +## playdoh Metrics + +```{r cloc, echo=FALSE} +cloc::cloc_pkg_md() +``` + +## Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). +By participating in this project you agree to abide by its terms. diff --git a/man/playdoh.Rd b/man/playdoh.Rd new file mode 100644 index 0000000..5ce5721 --- /dev/null +++ b/man/playdoh.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/playdoh-package.R +\docType{package} +\name{playdoh} +\alias{playdoh} +\alias{playdoh-package} +\title{...} +\description{ +\itemize{ +\item URL: \url{https://gitlab.com/hrbrmstr/playdoh} +\item BugReports: \url{https://gitlab.com/hrbrmstr/playdoh/issues} +} +} +\author{ +Bob Rudis (bob@rud.is) +} diff --git a/playdoh.Rproj b/playdoh.Rproj new file mode 100644 index 0000000..446d9e1 --- /dev/null +++ b/playdoh.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..6736256 --- /dev/null +++ b/tests/test-all.R @@ -0,0 +1,2 @@ +library(testthat) +test_check("playdoh") diff --git a/tests/testthat/test-playdoh.R b/tests/testthat/test-playdoh.R new file mode 100644 index 0000000..0c22968 --- /dev/null +++ b/tests/testthat/test-playdoh.R @@ -0,0 +1,6 @@ +context("minimal package functionality") +test_that("we can do something", { + + #expect_that(some_function(), is_a("data.frame")) + +})