From c07263794fb43007b894657b724f3159a2ec6574 Mon Sep 17 00:00:00 2001 From: hrbrmstr Date: Fri, 20 Mar 2020 14:25:05 -0400 Subject: [PATCH] R package repo initialization complete --- .Rbuildignore | 21 +++++++++++++++++++ .codecov.yml | 1 + .gitignore | 9 ++++++++ .travis.yml | 6 ++++++ CONDUCT.md | 25 +++++++++++++++++++++++ DESCRIPTION | 24 ++++++++++++++++++++++ NAMESPACE | 4 ++++ NEWS.md | 2 ++ R/imago-package.R | 9 ++++++++ README.Rmd | 51 ++++++++++++++++++++++++++++++++++++++++++++++ imago.Rproj | 21 +++++++++++++++++++ inst/tinytest/test_imago.R | 4 ++++ man/imago.Rd | 22 ++++++++++++++++++++ tests/tinytest.R | 5 +++++ 14 files changed, 204 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/imago-package.R create mode 100644 README.Rmd create mode 100644 imago.Rproj create mode 100644 inst/tinytest/test_imago.R create mode 100644 man/imago.Rd create mode 100644 tests/tinytest.R diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..c9a5c92 --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,21 @@ +^.vscode$ +^.*\.Rproj$ +^\.Rproj\.user$ +^\.travis\.yml$ +^README\.*Rmd$ +^README\.*html$ +^NOTES\.*Rmd$ +^NOTES\.*html$ +^\.codecov\.yml$ +^README_files$ +^doc$ +^docs$ +^tmp$ +^notes$ +^CONDUCT.*$ +^CODE.*$ +^\.gitlab-ci\.yml$ +^\.vscode$ +^CRAN-RELEASE$ +^appveyor\.yml$ +^tools$ 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..48e6972 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,24 @@ +Package: imago +Type: Package +Title: imago title goes here otherwise CRAN checks fail +Version: 0.1.0 +Date: 2020-03-20 +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://git.rud.is/hrbrmstr/imago +BugReports: https://git.rud.is/hrbrmstr/imago/issues +Encoding: UTF-8 +License: AGPL +Suggests: + covr, tinytest +Depends: + R (>= 3.2.0) +Imports: + httr, + jsonlite +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.0.2 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/imago-package.R b/R/imago-package.R new file mode 100644 index 0000000..c773ec5 --- /dev/null +++ b/R/imago-package.R @@ -0,0 +1,9 @@ +#' ... +#' +#' @md +#' @name imago +#' @keywords internal +#' @author Bob Rudis (bob@@rud.is) +#' @import httr +#' @importFrom jsonlite fromJSON +"_PACKAGE" diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000..afbf384 --- /dev/null +++ b/README.Rmd @@ -0,0 +1,51 @@ +--- +output: rmarkdown::github_document +editor_options: + chunk_output_type: console +--- +```{r pkg-knitr-opts, include=FALSE} +hrbrpkghelpr::global_opts() +``` + +```{r badges, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::stinking_badges() +``` + +```{r description, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::yank_title_and_description() +``` + +## What's Inside The Tin + +The following functions are implemented: + +```{r ingredients, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::describe_ingredients() +``` + +## Installation + +```{r install-ex, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::install_block() +``` + +## Usage + +```{r lib-ex} +library(imago) + +# current version +packageVersion("imago") + +``` + +## imago 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. +By participating in this project you agree to abide by its terms. diff --git a/imago.Rproj b/imago.Rproj new file mode 100644 index 0000000..446d9e1 --- /dev/null +++ b/imago.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/inst/tinytest/test_imago.R b/inst/tinytest/test_imago.R new file mode 100644 index 0000000..aa3f72e --- /dev/null +++ b/inst/tinytest/test_imago.R @@ -0,0 +1,4 @@ + +# Placeholder with simple test +expect_equal(1 + 1, 2) + diff --git a/man/imago.Rd b/man/imago.Rd new file mode 100644 index 0000000..bf57dd8 --- /dev/null +++ b/man/imago.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/imago-package.R +\docType{package} +\name{imago} +\alias{imago} +\alias{imago-package} +\title{...} +\description{ +A good description goes here otherwise CRAN checks fail. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://git.rud.is/hrbrmstr/imago} + \item Report bugs at \url{https://git.rud.is/hrbrmstr/imago/issues} +} + +} +\author{ +Bob Rudis (bob@rud.is) +} +\keyword{internal} diff --git a/tests/tinytest.R b/tests/tinytest.R new file mode 100644 index 0000000..7b550b5 --- /dev/null +++ b/tests/tinytest.R @@ -0,0 +1,5 @@ + +if ( requireNamespace("tinytest", quietly=TRUE) ){ + tinytest::test_package("imago") +} +