README.md

Research software impact CII Best Practices

Delaporte

Delaporte is an R package which provides the probability mass, distribution, quantile, random variate generation, and method of moments parameter estimation functions for the Delaporte distribution. As the distribution does not have a closed form but requires summations or double summations to calculate values, the functions have been programmed in Fortran and C. In cases where approximations are sufficient, the quantile and random variate generator have the option to use a much faster Poisson-negative binomial estimate as opposed to the full Delaporte double summations.

Acknowledgements

The author is grateful to Drew Schmidt both generally for his writings on R, C++, and Fortran and specifically for help with this project.

Contributions

Please ensure that all contributions comply with both R and CRAN standards for packages.

Versioning

This project attempts to follow Semantic Versioning

Changelog

This project attempts to follow the changelog system at Keep a CHANGELOG

Dependancies

This project intends to have as few dependancies as possible. Please consider that when writing code.

Style

Please review and conform to the current code stylistic choices (e.g. 80 character lines, two-space indentations).

Documentation

Please provide valid .Rd files and not roxygen-style documentation.

Tests

Please review the current test suite and supply similar testthat-compatible unit tests for all added functionality.

Submission

If you would like to contribute to the project, it may be prudent to first contact the maintainer via email. A request or suggestion may be raised as an issue as well. To supply a pull request (PR), please:

  1. Fork the project into your own local Bitbucket repository
  2. Create a branch in your repository in which you will make your changes
  3. Push that branch to Bitbucket and then create a pull request

At this point, the PR will be discussed and eventually accepted or rejected.



Try the Delaporte package in your browser

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

Delaporte documentation built on Nov. 22, 2018, 1:04 a.m.