~hrbrmstr/forcequotes

b7af04ff92567fae3393ac6068c9df5a888c51a4 — hrbrmstr 5 years ago 7c7d32a
R package repo initialization complete
A .Rbuildignore => .Rbuildignore +15 -0
@@ 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$

A .codecov.yml => .codecov.yml +1 -0
@@ 0,0 1,1 @@
comment: false

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

A .travis.yml => .travis.yml +6 -0
@@ 0,0 1,6 @@
language: R
sudo: false
cache: packages

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

A CONDUCT.md => CONDUCT.md +25 -0
@@ 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/

A DESCRIPTION => DESCRIPTION +25 -0
@@ 0,0 1,25 @@
Package: forcequotes
Type: Package
Title: forcequotes title goes here otherwise CRAN checks fail
Version: 0.1.0
Date: 2019-01-12
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/forcequotes
BugReports: https://gitlab.com/hrbrmstr/forcequotes/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

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

import(httr)
importFrom(jsonlite,fromJSON)

A NEWS.md => NEWS.md +2 -0
@@ 0,0 1,2 @@
0.1.0 
* Initial release

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

A README.Rmd => README.Rmd +50 -0
@@ 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/forcequotes.svg?branch=master)](https://travis-ci.org/hrbrmstr/forcequotes) 
[![Coverage Status](https://codecov.io/gh/hrbrmstr/forcequotes/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/forcequotes)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/forcequotes)](https://cran.r-project.org/package=forcequotes)

# forcequotes

## Description

## What's Inside The Tin

The following functions are implemented:

## Installation

```{r install-ex, eval=FALSE}
devtools::install_git("https://gitlab.com/hrbrmstr/forcequotes.git")
# or
devtools::install_github("hrbrmstr/forcequotes")
```

## Usage

```{r lib-ex}
library(forcequotes)

# current version
packageVersion("forcequotes")

```

## forcequotes 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.

A forcequotes.Rproj => forcequotes.Rproj +21 -0
@@ 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

A man/forcequotes.Rd => man/forcequotes.Rd +16 -0
@@ 0,0 1,16 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/forcequotes-package.R
\docType{package}
\name{forcequotes}
\alias{forcequotes}
\alias{forcequotes-package}
\title{...}
\description{
\itemize{
\item URL: \url{https://gitlab.com/hrbrmstr/forcequotes}
\item BugReports: \url{https://gitlab.com/hrbrmstr/forcequotes/issues}
}
}
\author{
Bob Rudis (bob@rud.is)
}

A tests/test-all.R => tests/test-all.R +2 -0
@@ 0,0 1,2 @@
library(testthat)
test_check("forcequotes")

A tests/testthat/test-forcequotes.R => tests/testthat/test-forcequotes.R +6 -0
@@ 0,0 1,6 @@
context("minimal package functionality")
test_that("we can do something", {

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

})