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.
Citation
If you use the package, please cite it as:
Avraham Adler (2013). Delaporte: Statistical Functions for the Delaporte Distribution. R package version 8.3.0. doi: 10.5281/zenodo.5880051 https://CRAN.R-project.org/package=Delaporte
A BibTeX entry for LaTeX users is:
@Manual{,
title = {Delaporte: Statistical Functions for the Delaporte Distribution},
author = {Avraham Adler},
year = {2013},
doi = {10.5281/zenodo.5880051},
url = {https://CRAN.R-project.org/package=Delaporte},
note = {R package version 8.3.0},
}
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.
Dependencies
This project intends to have as few dependencies as possible. Please consider that when writing code.
Style
Please conform to this coding style guide as best possible.
Documentation
Please provide valid .Rd files and not roxygen-style documentation.
Tests
Please review the current test suite and supply similar tinytest
-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:
- Fork the project and then clone into your own local repository
- Create a branch in your repository in which you will make your changes
- Ideally use -s to sign-off on commits under the
Developer Certificate of Origin. 4. If possible, sign commits using a GPG key. 5. Push that branch and then create a pull request
At this point, the PR will be discussed and eventually accepted or rejected by the lead maintainer.
Roadmap
Major
- There are no plans for major changes at current.
Minor
- There are no plans for minor changes at current.
Security
Expectations
This package is a calculation engine and requires no secrets or private information. It is checked for memory leaks prior to releases to CRAN using ASAN/UBSAN. Dissemination is handled by CRAN. Bugs are reported via the tracker and handled as soon as possible.
Assurance
The threat model is that a malicious actor would "poison" the package code by adding in elements having nothing to do with the package's purpose but which would be used for malicious purposes. This is protected against by having the email account of the maintainer—used for verification by CRAN—protected by a physical 2FA device (Yubikey) which is carried by the lead maintainer.