generated from greta-dev/greta.template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
125 lines (92 loc) · 3.13 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
## greta.censored: Censored Distributions for `greta`
<!-- badges: start -->
[](https://CRAN.R-project.org/package=greta.censored)
[](https://app.codecov.io/gh/mtwesley/greta.censored?branch=main)
[](https://github.com/mtwesley/greta.censored/actions)
<!-- badges: end -->
## Overview
`greta.censored` is an R package that extends [`greta`](https://github.com/greta-dev/greta) to support the following distributions with right, left, and interval censoring:
- Normal
- Log-Normal
- Student's T
- Gamma
- Exponential
- Weibull
- Pareto
- Beta
## Installation
You can install the stable version of `greta.censored` from CRAN with:
```r
install.packages("greta.censored")
```
Alternatively, you can install the development version from GitHub with:
```r
# install.packages("devtools")
devtools::install_github("mtwesley/greta.censored")
```
## Usage
Here are some examples demonstrating how to use the main functions of the `greta.censored` package:
### Example 1: Censored Normal Distribution
```r
library(greta)
library(greta.censored)
# Define the parameters
mean <- as.greta_array(0)
sd <- as.greta_array(1)
is_censored <- as.greta_array(c(0, 1, 0))
censor <- "right"
lower <- -Inf
upper <- 1
# Create the censored normal distribution
dist <- normal_censored(mean, sd, is_censored, censor, lower, upper)
# Print the distribution
print(dist)
```
### Example 2: Censored Log-Normal Distribution
```r
library(greta)
library(greta.censored)
# Define the parameters
meanlog <- as.greta_array(0)
sdlog <- as.greta_array(1)
is_censored <- as.greta_array(c(0, 1, 0))
censor <- "left"
lower <- 0
upper <- Inf
# Create the censored log-normal distribution
dist <- lognormal_censored(meanlog, sdlog, is_censored, censor, lower, upper)
# Print the distribution
print(dist)
```
## Code of Conduct
Please note that the `greta.censored` project is released with a [Code of Conduct](https://github.com/mtwesley/greta.censored/blob/main/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
## Citation
If you use the `greta.censored` package, please cite it as follows:
Wesley M (2024). _greta.censored: Censored Distributions for 'greta'_. R package version 0.1.0, <https://CRAN.R-project.org/package=greta.censored>.
Or use the following:
```r
citation("greta.censored")
```
Or in BibTeX format:
```
@Manual{
title = {greta.censored: Censored Distributions for 'greta'},
author = {Mlen-Too Wesley},
year = {2024},
note = {R package version 0.1.0},
url = {https://CRAN.R-project.org/package=greta.censored},
}
```
Alternatively, refer to the package's CRAN page: [greta.censored on CRAN](https://CRAN.R-project.org/package=greta.censored).