Code Monkey home page Code Monkey logo

rrtools's Introduction

Experimental Fork for:

rrtools: Tools for Writing Reproducible Research in R

For the production version of rrtoolts go to: https://github.com/benmarwick/rrtools

Project Template

The focus of this fork is to provide a simple template for the creation of a basic research compendium using the rrtools package. This approach takes advantage of the new Project Template option in RStudio Version 1.1.xxx. See here for some details of how it is implemented. What this branch provides is a way to use the new Project Template as a user interface to creating a basic research compendium. The basic compendium template includes the most common options of compendium setup including folder structure, Github, README, and MIT license. More advanced options such as using continuous integration (CI) will require a separate action once the package is created. Even is CI is desired, the basic project template can still be used for the initial package creation. This is an experimental use of the new package template framework and will surely have bugs. Please report those as Issues or Pull Requests and I will sort it out.

Usage

1- Install this branch of rrtools

# install.packages("devtools")
devtools::install_github("mrecos/rrtools")
library("rrtools")
you may have to resart RStudio if this your first use.

2 - Create New Project

Note: The package name should contain only ASCII letters, numbers and dot, have at least two characters and start with a letter and not end in a dot. Otherwise, you will get an error telling you such.

3 - Select 'Create Reserch Compendium'

4 - Select Options and Provide Info

To use GitHub you will need a GitHub account and peronal API token

5 - Accept Description Default (will fix this soon)

6 - Success!

From this basic package setup, there are additional options that can be used, Description and README.Rmd to fill in. Check out the main branch of rrtoolsfor info.

rrtools's People

Contributors

mrecos avatar benmarwick avatar nevrome avatar pkq avatar dakni avatar rsbraun avatar scschmidt avatar

Stargazers

Hansjörg Plieninger avatar HarryZhu avatar  avatar Nick Gauthier avatar Adam H. Sparks avatar Francisco Rodriguez-Sanchez avatar  avatar

Watchers

James Cloos avatar Ross Gayler avatar  avatar

rrtools's Issues

knitr error with use_README option in template

using the "use README" option in the template throws an error in new rrtools project. Look into this

* Creating `README.Rmd` from template.
* Adding `README.Rmd` to `.Rbuildignore`.
* Modify `README.Rmd`.
* Rendering README.Rmd to README.md for GitHub.
Error: pandoc version 1.12.3 or higher is required and was not found (see the help page ?rmarkdown::pandoc_available).
'/Library/Frameworks/R.framework/Resources/bin/R' --no-site-file --no-environ  \
  --no-save --no-restore --quiet CMD build  \
  '/Users/mattharris/Documents/R_Local/temp/temp1' --no-resave-data  \
  --no-manual 

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.