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..9fdbc73 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,25 @@ +Package: attckr +Type: Package +Title: attckr title goes here otherwise CRAN checks fail +Version: 0.1.0 +Date: 2019-05-28 +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/attckr +BugReports: https://gitlab.com/hrbrmstr/attckr/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/attckr-package.R b/R/attckr-package.R new file mode 100644 index 0000000..81c184e --- /dev/null +++ b/R/attckr-package.R @@ -0,0 +1,12 @@ +#' ... +#' +#' - URL: +#' - BugReports: +#' +#' @md +#' @name attckr +#' @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..10bd515 --- /dev/null +++ b/README.Rmd @@ -0,0 +1,50 @@ +--- +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/attckr.svg?branch=master)](https://travis-ci.org/hrbrmstr/attckr) +[![Coverage Status](https://codecov.io/gh/hrbrmstr/attckr/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/attckr) +[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/attckr)](https://cran.r-project.org/package=attckr) + +# attckr + +## Description + +## What's Inside The Tin + +The following functions are implemented: + +## Installation + +```{r install-ex, eval=FALSE} +devtools::install_git("https://gitlab.com/hrbrmstr/attckr.git") +# or +devtools::install_github("hrbrmstr/attckr") +``` + +## Usage + +```{r lib-ex} +library(attckr) + +# current version +packageVersion("attckr") + +``` + +## attckr 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/attckr.Rproj b/attckr.Rproj new file mode 100644 index 0000000..446d9e1 --- /dev/null +++ b/attckr.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/man/attckr.Rd b/man/attckr.Rd new file mode 100644 index 0000000..c0cd8d7 --- /dev/null +++ b/man/attckr.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/attckr-package.R +\docType{package} +\name{attckr} +\alias{attckr} +\alias{attckr-package} +\title{...} +\description{ +\itemize{ +\item URL: \url{https://gitlab.com/hrbrmstr/attckr} +\item BugReports: \url{https://gitlab.com/hrbrmstr/attckr/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..fe1220e --- /dev/null +++ b/tests/test-all.R @@ -0,0 +1,2 @@ +library(testthat) +test_check("attckr") diff --git a/tests/testthat/test-attckr.R b/tests/testthat/test-attckr.R new file mode 100644 index 0000000..0c22968 --- /dev/null +++ b/tests/testthat/test-attckr.R @@ -0,0 +1,6 @@ +context("minimal package functionality") +test_that("we can do something", { + + #expect_that(some_function(), is_a("data.frame")) + +})