university-of-newcastle-research / pmwg

Repository for code for the Samplers Team at UoN
3 stars 3 forks source link

Add more examples to the documentation #38

Closed gjcooper closed 3 years ago

gjcooper commented 3 years ago

Is your feature request related to a problem? Please describe. There are very few examples listed in the roxygen comments (and thus built into the documentation)

Describe the solution you'd like Every exported function should have at least one clear and concise example.

Additional context Good examples may be hard for some functions as they require a sampled object. Need to figure a way to include a pre-sampled object?