README.md

README

This README documents the steps necessary to get dynr cooking. That was the first of many food-based puns. It will not be the last.

Who is this repository for?

This repository is primarily for developers. If you're not currently on the development team but would like to be, please contact Sy-Miin Chow at Pennsylvania State University. You will need

If you're not a developer and just want to install dynr to run your models, please see the CRAN page including the vignette with installation guidelines.

How do I get set up?

Windows People

Mac People

Contribution guidelines

We primarily use a centralized workflow in git. Occasionally, we employ a feature branch style for larger features that may break the master branch for extended periods of time.

Please follow these basic guidelines when writing commit messages.

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why, not how

We use win-builder to help test the repository prior to submitting a new release to CRAN.

A Note to developers: there is a bug in roxygen2 such that the latest version will not build our documentation. It is a known issue that will be resolved soon. In the meantime, use an older version of the package. Install it with devtools::install_version(package = 'roxygen2',version = '5.0.1', repos = c(CRAN = "https://cran.rstudio.com"))

Who do I talk to?

Contact the Repo owner to obtain read and write permissions to this repository.



Try the dynr package in your browser

Any scripts or data that you put into this service are public.

dynr documentation built on Feb. 9, 2018, 6:07 a.m.