Skip to content

Commit

Permalink
barebones setup (CI, pkgdown, etc)
Browse files Browse the repository at this point in the history
  • Loading branch information
jhrcook committed Mar 20, 2020
1 parent 12159f9 commit 6898a4d
Show file tree
Hide file tree
Showing 22 changed files with 2,511 additions and 7 deletions.
8 changes: 8 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
^.*\.Rproj$
^\.Rproj\.user$
^LICENSE\.md$
^README\.Rmd$
^\.travis\.yml$
^appveyor\.yml$
^codecov\.yml$
^_pkgdown\.yml$
^docs$
^pkgdown$
7 changes: 7 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# R for travis: see documentation at https://docs.travis-ci.com/user/languages/r

language: R
cache: packages

after_success:
- Rscript -e 'covr::codecov()'
20 changes: 13 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
Package: stashR
Type: Package
Title: What the Package Does (Title Case)
Version: 0.1.0
Author: Who wrote it
Maintainer: The package maintainer <[email protected]>
Description: More about what it does (maybe more than one line)
Use four spaces when indenting paragraphs within the Description.
License: What license is it under?
Title: Stash and Load Objects in R
Version: 0.0.0.9000
Authors@R: person(c("Joshua", "H"), "Cook", email = "[email protected]",
role = c("aut", "cre"),
comment = c(ORCID = "0000-0001-9815-6879"))
https: //github.com/jhrcook/stashR https://jhrcook.github.io/stashR/
Description: A simple system for saving and loading objects in R. Long running
computations can be stashed after the first run and then reloaded the next
time. Dependencies can be added to ensure that a computation is re-run if
any of its dependencies or inputs have changed.
License: GPL-3
Encoding: UTF-8
LazyData: true
Suggests:
covr
595 changes: 595 additions & 0 deletions LICENSE.md

Large diffs are not rendered by default.

63 changes: 63 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# stashR

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/stashR)](https://CRAN.R-project.org/package=stashR)
[![Travis build status](https://travis-ci.org/jhrcook/stashR.svg?branch=master)](https://travis-ci.org/jhrcook/stashR)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/jhrcook/stashR?branch=master&svg=true)](https://ci.appveyor.com/project/jhrcook/stashR)
[![Codecov test coverage](https://codecov.io/gh/jhrcook/stashR/branch/master/graph/badge.svg)](https://codecov.io/gh/jhrcook/stashR?branch=master)
<!-- badges: end -->

The goal of stashR is to ...

## Installation

You can install the released version of stashR from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("stashR")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("jhrcook/stashR")
```
## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
# library(stashR)
```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date.

You can also embed plots, for example:

```{r pressure, echo = FALSE}
plot(pressure)
```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub!
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# stashR

<!-- badges: start -->

[![CRAN
status](https://www.r-pkg.org/badges/version/stashR)](https://CRAN.R-project.org/package=stashR)
[![Travis build
status](https://travis-ci.org/jhrcook/stashR.svg?branch=master)](https://travis-ci.org/jhrcook/stashR)
[![AppVeyor build
status](https://ci.appveyor.com/api/projects/status/github/jhrcook/stashR?branch=master&svg=true)](https://ci.appveyor.com/project/jhrcook/stashR)
[![Codecov test
coverage](https://codecov.io/gh/jhrcook/stashR/branch/master/graph/badge.svg)](https://codecov.io/gh/jhrcook/stashR?branch=master)
<!-- badges: end -->

The goal of stashR is to …

## Installation

You can install the released version of stashR from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("stashR")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("jhrcook/stashR")
```

## Example

This is a basic example which shows you how to solve a common problem:

``` r
# library(stashR)
```

What is special about using `README.Rmd` instead of just `README.md`?
You can include R chunks like so:

``` r
summary(cars)
#> speed dist
#> Min. : 4.0 Min. : 2.00
#> 1st Qu.:12.0 1st Qu.: 26.00
#> Median :15.0 Median : 36.00
#> Mean :15.4 Mean : 42.98
#> 3rd Qu.:19.0 3rd Qu.: 56.00
#> Max. :25.0 Max. :120.00
```

You’ll still need to render `README.Rmd` regularly, to keep `README.md`
up-to-date.

You can also embed plots, for example:

<img src="man/figures/README-pressure-1.png" width="100%" />

In that case, don’t forget to commit and push the resulting figure
files, so they display on GitHub\!
1 change: 1 addition & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
destination: docs
52 changes: 52 additions & 0 deletions appveyor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# DO NOT CHANGE the "init" and "install" sections below

# Download script file from GitHub
init:
ps: |
$ErrorActionPreference = "Stop"
Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1"
Import-Module '..\appveyor-tool.ps1'
install:
ps: Bootstrap

cache:
- C:\RLibrary

environment:
NOT_CRAN: true
# env vars that may need to be set, at least temporarily, from time to time
# see https://github.com/krlmlr/r-appveyor#readme for details
# USE_RTOOLS: true
# R_REMOTES_STANDALONE: true

# Adapt as necessary starting from here

build_script:
- travis-tool.sh install_deps

test_script:
- travis-tool.sh run_tests

on_failure:
- 7z a failure.zip *.Rcheck\*
- appveyor PushArtifact failure.zip

artifacts:
- path: '*.Rcheck\**\*.log'
name: Logs

- path: '*.Rcheck\**\*.out'
name: Logs

- path: '*.Rcheck\**\*.fail'
name: Logs

- path: '*.Rcheck\**\*.Rout'
name: Logs

- path: '\*_*.tar.gz'
name: Bits

- path: '\*_*.zip'
name: Bits
12 changes: 12 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
comment: false

coverage:
status:
project:
default:
target: auto
threshold: 1%
patch:
default:
target: auto
threshold: 1%
130 changes: 130 additions & 0 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6898a4d

Please sign in to comment.