Browse Source

R package repo initialization complete

pure-r
boB Rudis 10 months ago
parent
commit
e7cfa03d87
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
14 changed files with 196 additions and 0 deletions
  1. +15
    -0
      .Rbuildignore
  2. +1
    -0
      .codecov.yml
  3. +9
    -0
      .gitignore
  4. +6
    -0
      .travis.yml
  5. +25
    -0
      CONDUCT.md
  6. +25
    -0
      DESCRIPTION
  7. +4
    -0
      NAMESPACE
  8. +2
    -0
      NEWS.md
  9. +12
    -0
      R/playdoh-package.R
  10. +52
    -0
      README.Rmd
  11. +16
    -0
      man/playdoh.Rd
  12. +21
    -0
      playdoh.Rproj
  13. +2
    -0
      tests/test-all.R
  14. +6
    -0
      tests/testthat/test-playdoh.R

+ 15
- 0
.Rbuildignore View File

@@ -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$

+ 1
- 0
.codecov.yml View File

@@ -0,0 +1 @@
comment: false

+ 9
- 0
.gitignore View File

@@ -0,0 +1,9 @@
.DS_Store
.Rproj.user
.Rhistory
.RData
.Rproj
README_cache
src/*.o
src/*.so
src/*.dll

+ 6
- 0
.travis.yml View File

@@ -0,0 +1,6 @@
language: R
sudo: false
cache: packages

after_success:
- Rscript -e 'covr::codecov()'

+ 25
- 0
CONDUCT.md View File

@@ -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/

+ 25
- 0
DESCRIPTION View File

@@ -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 <bob@rud.is>
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

+ 4
- 0
NAMESPACE View File

@@ -0,0 +1,4 @@
# Generated by roxygen2: do not edit by hand

import(httr)
importFrom(jsonlite,fromJSON)

+ 2
- 0
NEWS.md View File

@@ -0,0 +1,2 @@
0.1.0
* Initial release

+ 12
- 0
R/playdoh-package.R View File

@@ -0,0 +1,12 @@
#' ...
#'
#' - URL: <https://gitlab.com/hrbrmstr/playdoh>
#' - BugReports: <https://gitlab.com/hrbrmstr/playdoh/issues>
#'
#' @md
#' @name playdoh
#' @docType package
#' @author Bob Rudis (bob@@rud.is)
#' @import httr
#' @importFrom jsonlite fromJSON
NULL

+ 52
- 0
README.Rmd View File

@@ -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.

+ 16
- 0
man/playdoh.Rd View File

@@ -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)
}

+ 21
- 0
playdoh.Rproj View File

@@ -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

+ 2
- 0
tests/test-all.R View File

@@ -0,0 +1,2 @@
library(testthat)
test_check("playdoh")

+ 6
- 0
tests/testthat/test-playdoh.R View File

@@ -0,0 +1,6 @@
context("minimal package functionality")
test_that("we can do something", {

#expect_that(some_function(), is_a("data.frame"))

})

Loading…
Cancel
Save