Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ocbe-uio/truncexpfam
R package to generate data related to the Truncated Exponential Family
https://github.com/ocbe-uio/truncexpfam
r-package truncated-distribution
Last synced: about 1 month ago
JSON representation
R package to generate data related to the Truncated Exponential Family
- Host: GitHub
- URL: https://github.com/ocbe-uio/truncexpfam
- Owner: ocbe-uio
- License: gpl-3.0
- Created: 2021-01-04T06:29:26.000Z (about 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-26T06:30:01.000Z (3 months ago)
- Last Synced: 2024-10-28T17:32:46.494Z (2 months ago)
- Topics: r-package, truncated-distribution
- Language: R
- Homepage: https://ocbe-uio.github.io/TruncExpFam/
- Size: 6.16 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
What is this?
=============
This is an R package to handle truncated members from the exponential
family.
Installation
============
Stable version
--------------
TruncExpFam is available on CRAN and can be installed by running the
following in an interactive R session:
```r
install.packages("TruncExpFam")
```
Development version
-------------------
The development version of the package contains features and bug fixes
that are yet to be published. It is, however, much less stable than the
CRAN version. You can install the development version of TruncExpFam by
running the following command in R (requires the `remotes` package to be
installed beforehand):
```r
remotes::install_github("ocbe-uio/TruncExpFam")
```
If you want to browse the vignette, add `build_vignettes = TRUE` to your `install_github()` command.
Further details on installing TruncExpFam can be found on the
[Wiki](https://github.com/ocbe-uio/TruncExpFam/wiki/Installing-TruncExpFam).
Usage
=====
Once installed, `TruncExpFam` can be loaded with `library(TruncExpFam)`. A list of
available functions can be printed with `ls("package:TruncExpFam")`.
For more information about the package (e.g. supported distributions),
run `?TruncExpFam` after loading the package in your R session.
Are you familiar with the stats package and its `r*` and `d*` functions
such as `rnorm()` and `dpois()`? If so, you will feel right at home with
`TruncExpFam`, which uses the `rtrunc()` function to generate random
numbers and the `dtrunc()` function to generate probability densities.
For a more detailed explanation on how to use this package’s features,
check out its vignette:
```r
browseVignettes("TruncExpFam")
```
Contributing
============
TruncExpFam is open-source software licensed by the GPL. All
contributions are welcome! Please use the [issues
page](https://github.com/ocbe-uio/TruncExpFam/issues) to submit any bugs
you find or see what other issues have been submitted.
To contribute with code, we recommend reading [this Wiki
page](https://github.com/ocbe-uio/TruncExpFam/wiki/Contributing-to-the-project)
on the subject.
Citing
======
If you present work that uses this package, please remember to cite it. To cite TruncExpFam in publications, use the output of `citation("TruncExpFam")` on your R session.
Badges
======
Stable version
--------------
[](https://cran.r-project.org/package=TruncExpFam)
[](https://cran.r-project.org/package=TruncExpFam)
[](https://cran.r-project.org/web/licenses/GPL-3)
[](https://zenodo.org/badge/latestdoi/326590808)
Development version
-------------------
[](https://www.repostatus.org/#active)
[](https://github.com/ocbe-uio/TruncExpFam/commits/develop)
[](https://github.com/ocbe-uio/TruncExpFam)
[](https://github.com/ocbe-uio/TruncExpFam/actions)
[](https://codecov.io/gh/ocbe-uio/TruncExpFam)
[](https://www.codefactor.io/repository/github/ocbe-uio/TruncExpFam)