-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
check for upper case compendium name
- Loading branch information
Ben Marwick
committed
Jul 16, 2018
1 parent
ddf0b72
commit e1da652
Showing
81 changed files
with
58,404 additions
and
58,364 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
^.*\.Rproj$ | ||
^\.Rproj\.user$ | ||
^README\.Rmd$ | ||
^README-.*\.png$ | ||
^\.travis\.yml$ | ||
^CONDUCT\.md$ | ||
^Dockerfile$ | ||
analysis | ||
^circle\.yml$ | ||
^CONTRIBUTING\.md$ | ||
thesis | ||
^LICENSE\.md$ | ||
^.*\.Rproj$ | ||
^\.Rproj\.user$ | ||
^README\.Rmd$ | ||
^README-.*\.png$ | ||
^\.travis\.yml$ | ||
^CONDUCT\.md$ | ||
^Dockerfile$ | ||
analysis | ||
^circle\.yml$ | ||
^CONTRIBUTING\.md$ | ||
thesis | ||
^LICENSE\.md$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
.Rproj.user | ||
.Rhistory | ||
.RData | ||
.Ruserdata | ||
*/data/* | ||
.Rproj.user | ||
.Rhistory | ||
.RData | ||
.Ruserdata | ||
*/data/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,25 @@ | ||
# Build our Docker container and R pkg on Travis | ||
language: r | ||
sudo: required | ||
cache: packages | ||
|
||
env: | ||
global: | ||
- REPO=$DOCKER_USER/rrtools | ||
|
||
warnings_are_errors: false | ||
|
||
services: | ||
- docker | ||
|
||
after_success: | ||
# create & run container using our dockerfile, i.e. compile pkg and render Rmd to Word doc | ||
- docker build -t $REPO . | ||
# push our custom docker container to docker hub, env vars stored on travis-ci.org | ||
- docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS | ||
- export REPO=$DOCKER_USER/rrtools | ||
- export TAG=`if [ "$TRAVIS_BRANCH" == "master" ]; then echo "latest"; else echo $TRAVIS_BRANCH ; fi` | ||
- docker build -f Dockerfile -t $REPO:$COMMIT . | ||
- docker tag $REPO:$COMMIT $REPO:$TAG | ||
- docker tag $REPO:$COMMIT $REPO:travis-$TRAVIS_BUILD_NUMBER | ||
- docker push $REPO | ||
# Build our Docker container and R pkg on Travis | ||
language: r | ||
sudo: required | ||
cache: packages | ||
|
||
env: | ||
global: | ||
- REPO=$DOCKER_USER/rrtools | ||
|
||
warnings_are_errors: false | ||
|
||
services: | ||
- docker | ||
|
||
after_success: | ||
# create & run container using our dockerfile, i.e. compile pkg and render Rmd to Word doc | ||
- docker build -t $REPO . | ||
# push our custom docker container to docker hub, env vars stored on travis-ci.org | ||
- docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS | ||
- export REPO=$DOCKER_USER/rrtools | ||
- export TAG=`if [ "$TRAVIS_BRANCH" == "master" ]; then echo "latest"; else echo $TRAVIS_BRANCH ; fi` | ||
- docker build -f Dockerfile -t $REPO:$COMMIT . | ||
- docker tag $REPO:$COMMIT $REPO:$TAG | ||
- docker tag $REPO:$COMMIT $REPO:travis-$TRAVIS_BUILD_NUMBER | ||
- docker push $REPO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +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/ | ||
# 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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,41 @@ | ||
# Contributing | ||
|
||
We love pull requests from everyone. By participating in this project, you | ||
agree to abide by our [code of conduct](CONDUCT.md). | ||
|
||
## Getting Started | ||
|
||
* Make sure you have a [GitHub account](https://github.com/signup/free). If you are not familar with git and GitHub, take a look at <http://happygitwithr.com/> to get started. | ||
* [Submit a post for your issue](https://github.com/benmarwick/rrtools/issues/), assuming one does not already exist. | ||
* Clearly describe your issue, including steps to reproduce when it is a bug, or some justification for a proposed improvement. | ||
* [Fork](https://github.com/benmarwick/rrtools/#fork-destination-box) the repository on GitHub to make a copy of the repository on your account. Or use this line in your shell terminal: | ||
|
||
`git clone git@github.com:your-username/rrtools.git` | ||
|
||
## Making changes | ||
|
||
* Edit the files, save often, and make commits of logical units, where each commit indicates one concept | ||
* Follow our [style guide](http://adv-r.had.co.nz/Style.html). | ||
* Make sure you write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
* Make sure you have added the necessary tests for your code changes. | ||
* Run _all_ the tests using `devtools::check()` to assure nothing else was accidentally broken. | ||
* If you need help or unsure about anything, post an update to [your issue](https://github.com/benmarwick/rrtools/issues/). | ||
|
||
## Submitting your changes | ||
|
||
Push to your fork and [submit a pull request](https://github.com/benmarwick/rrtools/compare/). | ||
|
||
At this point you're waiting on us. We like to at least comment on pull requests | ||
within a few days (and, typically, one business day). We may suggest | ||
some changes or improvements or alternatives. | ||
|
||
Some things you can do that will increase the chance that your pull request is accepted: | ||
|
||
* Engage in discussion on [your issue](https://github.com/benmarwick/rrtools/issues/). | ||
* Be familiar with the background literature cited in the [README](README.Rmd) | ||
* Write tests that pass `devtools::check()`. | ||
* Follow our [code style guide](http://adv-r.had.co.nz/Style.html). | ||
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
|
||
|
||
# Contributing | ||
|
||
We love pull requests from everyone. By participating in this project, you | ||
agree to abide by our [code of conduct](CONDUCT.md). | ||
|
||
## Getting Started | ||
|
||
* Make sure you have a [GitHub account](https://github.com/signup/free). If you are not familar with git and GitHub, take a look at <http://happygitwithr.com/> to get started. | ||
* [Submit a post for your issue](https://github.com/benmarwick/rrtools/issues/), assuming one does not already exist. | ||
* Clearly describe your issue, including steps to reproduce when it is a bug, or some justification for a proposed improvement. | ||
* [Fork](https://github.com/benmarwick/rrtools/#fork-destination-box) the repository on GitHub to make a copy of the repository on your account. Or use this line in your shell terminal: | ||
|
||
`git clone git@github.com:your-username/rrtools.git` | ||
|
||
## Making changes | ||
|
||
* Edit the files, save often, and make commits of logical units, where each commit indicates one concept | ||
* Follow our [style guide](http://adv-r.had.co.nz/Style.html). | ||
* Make sure you write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
* Make sure you have added the necessary tests for your code changes. | ||
* Run _all_ the tests using `devtools::check()` to assure nothing else was accidentally broken. | ||
* If you need help or unsure about anything, post an update to [your issue](https://github.com/benmarwick/rrtools/issues/). | ||
|
||
## Submitting your changes | ||
|
||
Push to your fork and [submit a pull request](https://github.com/benmarwick/rrtools/compare/). | ||
|
||
At this point you're waiting on us. We like to at least comment on pull requests | ||
within a few days (and, typically, one business day). We may suggest | ||
some changes or improvements or alternatives. | ||
|
||
Some things you can do that will increase the chance that your pull request is accepted: | ||
|
||
* Engage in discussion on [your issue](https://github.com/benmarwick/rrtools/issues/). | ||
* Be familiar with the background literature cited in the [README](README.Rmd) | ||
* Write tests that pass `devtools::check()`. | ||
* Follow our [code style guide](http://adv-r.had.co.nz/Style.html). | ||
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,25 @@ | ||
Package: rrtools | ||
Type: Package | ||
Title: Creates a reproducible research compendium | ||
Version: 0.1.0 | ||
Authors@R: c(person("Ben", "Marwick", role = c("aut", "cre"), email = "benmarwick@gmail.com"), | ||
person("Daniel", "Knitter", role = "ctb"), | ||
person("Patrick", "Kennedy", role = "ctb"), | ||
person("Nils", "Muller-Scheessel", role = "ctb"), | ||
person("Martin", "Hinz", role = "ctb"), | ||
person("Clemens", "Schmid", role = "ctb"), | ||
person("Ricarda", "Braun", role = "ctb"), | ||
person("Wojciech", "Francuzik", role = "ctb")) | ||
Maintainer: Ben Marwick <benmarwick@gmail.com> | ||
Description: Instructions, templates, and functions for making a basic | ||
compendium suitable for doing reproducible research with R. | ||
License: MIT + file LICENSE | ||
Imports: devtools, git2r, whisker, rstudioapi, rmarkdown, knitr, | ||
bookdown, curl, RCurl, jsonlite, methods, httr, usethis, | ||
readr (>= 1.1.1) | ||
Encoding: UTF-8 | ||
LazyData: true | ||
URL: https://github.com/benmarwick/rrtools | ||
BugReports: https://github.com/benmarwick/rrtools/issues | ||
Suggests: testthat | ||
RoxygenNote: 6.0.1 | ||
Package: rrtools | ||
Type: Package | ||
Title: Creates a reproducible research compendium | ||
Version: 0.1.0 | ||
Authors@R: c(person("Ben", "Marwick", role = c("aut", "cre"), email = "benmarwick@gmail.com"), | ||
person("Daniel", "Knitter", role = "ctb"), | ||
person("Patrick", "Kennedy", role = "ctb"), | ||
person("Nils", "Muller-Scheessel", role = "ctb"), | ||
person("Martin", "Hinz", role = "ctb"), | ||
person("Clemens", "Schmid", role = "ctb"), | ||
person("Ricarda", "Braun", role = "ctb"), | ||
person("Wojciech", "Francuzik", role = "ctb")) | ||
Maintainer: Ben Marwick <benmarwick@gmail.com> | ||
Description: Instructions, templates, and functions for making a basic | ||
compendium suitable for doing reproducible research with R. | ||
License: MIT + file LICENSE | ||
Imports: devtools, git2r, whisker, rstudioapi, rmarkdown, knitr, | ||
bookdown, curl, RCurl, jsonlite, methods, httr, usethis, | ||
readr (>= 1.1.1) | ||
Encoding: UTF-8 | ||
LazyData: true | ||
URL: https://github.com/benmarwick/rrtools | ||
BugReports: https://github.com/benmarwick/rrtools/issues | ||
Suggests: testthat | ||
RoxygenNote: 6.0.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,22 @@ | ||
# get the base image, the rocker/verse has R, RStudio and pandoc | ||
FROM rocker/verse:3.4.3 | ||
|
||
# required | ||
MAINTAINER Ben Marwick <benmarwick@gmail.com> | ||
|
||
COPY . /rrtools | ||
|
||
# go into the repo directory | ||
RUN . /etc/environment \ | ||
|
||
# Install linux depedendencies here | ||
# e.g. need this for ggforce::geom_sina | ||
&& sudo apt-get update \ | ||
&& sudo apt-get install libudunits2-dev -y \ | ||
|
||
# build this compendium package | ||
&& R -e "devtools::install('/rrtools', dep=TRUE)" \ | ||
|
||
# render the manuscript into a docx, you'll need to edit this if you've | ||
# customised the location and name of your main Rmd file | ||
&& R -e "rmarkdown::render('/rrtools/analysis/paper/paper.Rmd')" | ||
# get the base image, the rocker/verse has R, RStudio and pandoc | ||
FROM rocker/verse:3.4.3 | ||
|
||
# required | ||
MAINTAINER Ben Marwick <benmarwick@gmail.com> | ||
|
||
COPY . /rrtools | ||
|
||
# go into the repo directory | ||
RUN . /etc/environment \ | ||
|
||
# Install linux depedendencies here | ||
# e.g. need this for ggforce::geom_sina | ||
&& sudo apt-get update \ | ||
&& sudo apt-get install libudunits2-dev -y \ | ||
|
||
# build this compendium package | ||
&& R -e "devtools::install('/rrtools', dep=TRUE)" \ | ||
|
||
# render the manuscript into a docx, you'll need to edit this if you've | ||
# customised the location and name of your main Rmd file | ||
&& R -e "rmarkdown::render('/rrtools/analysis/paper/paper.Rmd')" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
YEAR: 2017 | ||
COPYRIGHT HOLDER: Ben Marwick | ||
YEAR: 2017 | ||
COPYRIGHT HOLDER: Ben Marwick |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
# MIT License | ||
|
||
Copyright (c) 2017 Ben Marwick | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
# MIT License | ||
|
||
Copyright (c) 2017 Ben Marwick | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.