Giter VIP home page Giter VIP logo

skeleton-project's Introduction

Project Name

Skeleton setup for a Rmarkdown based workflow using GNU Make as the taskrunner.

To get started, setup first a new project using a shallow git clone.

$ git clone --depth 1 [email protected]:jsks/skeleton-project.git <project-directory>

# Change origin to desired remote repository
$ cd <project-directory>
$ git remote set-url origin [email protected]:<username>/<project-repo>.git

Next, access the documentation for the default rules in the included Makefile with the help target.

$ make help

Compiling Rmd files

The barebones Makefile includes support for converting Rmarkdown files to docx, html, and pdf outputs.

To compile the example skeleton.Rmd file, install R, pandoc, and the following R packages:

$ Rscript -e "install.packages('rmarkdown', 'dplyr', 'ggplot2', 'ggthemes', 'kableExtra', 'knitr')"
$ make skeleton.pdf

Alternatively, a barebones container image from the latest version of r-base with all necessary packages is also available.

$ docker pull ghcr.io/jsks/skeleton:4.2.0
$ docker run -v $PWD:/proj --rm -it R

Directory Structure

bin/        # Shell scripts
data/       # Raw and generated data files
R/          # R scripts
refs/       # Reference files
posteriors/ # Model outputs
stan/       # Stan code

skeleton-project's People

Contributors

jsks avatar

Watchers

 avatar

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.