In RaphaelS1/distr6: The Complete R6 Probability Distributions Interface

library(distr6)
set.seed(42)
knitr::opts_chunk$set(collapse = TRUE, comment = "#>")

Here Be Dragons

When extending SDistributions, Kernels, Wrappers and Decorators, there are no formal checks on the quality or accuracy of your code. Whilst distr6 is modularised in such a way that a new class with a bug in it won't crash the rest of the package, it is still important that they can be interfaced properly with parent classes. The next few tutorials will go through how to extend the SDistribution, Kernel, Wrapper and Decorator classes but first please make sure you have gone through the preliminary checklist below. Of course, if you don't intend to make a pull-request to add your extension to the distr6 package, then feel free to go right on ahead and start here.

distr6 Pull-Request Preliminaries

• Analytic and numeric methods for how we separate numeric and analytic methods and where these should go
• Documentation for the correct way to document your new class or function
• R vs C for why we won't accept pull requests written in C
• R6 and Design patterns for our R6 design pattern workarounds
• Project wiki for a summary of the above as well as guidelines on unit tests and file naming

Extension Guidelines

• SDistribution
• Kernel
• Wrapper
• Decorator

RaphaelS1/distr6 documentation built on Feb. 24, 2024, 9:14 p.m.