From bf9c8dbc4b3e2edaf33a0b7ade16c4f87ffcf7b4 Mon Sep 17 00:00:00 2001 From: mtwesley Date: Fri, 29 Nov 2024 06:01:56 -0500 Subject: [PATCH] updates to README knitted --- README.Rmd | 18 +++++++++++++++++- README.md | 44 +++++++++++++++++++++++++++++++++++--------- 2 files changed, 52 insertions(+), 10 deletions(-) diff --git a/README.Rmd b/README.Rmd index fae93d4..f40aadb 100644 --- a/README.Rmd +++ b/README.Rmd @@ -100,10 +100,26 @@ Please note that the `greta.censored` project is released with a [Code of Conduc ## Citation -If you use the `greta.censored` package in your research, please cite it as follows: +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, . + +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). \ No newline at end of file diff --git a/README.md b/README.md index 1ea7475..b79527e 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,9 @@ ## greta.censored: Censored Distributions for `greta` - +[![CRAN +status](https://www.r-pkg.org/badges/version/greta.censored)](https://CRAN.R-project.org/package=greta.censored) [![Codecov test coverage](https://codecov.io/gh/mtwesley/greta.censored/branch/main/graph/badge.svg)](https://app.codecov.io/gh/mtwesley/greta.censored?branch=main) [![R-CMD-check](https://github.com/mtwesley/greta.censored/workflows/R-CMD-check/badge.svg)](https://github.com/mtwesley/greta.censored/actions) @@ -24,12 +25,17 @@ distributions with right, left, and interval censoring: - Exponential - Weibull - Pareto -- Beta. +- Beta ## Installation -You can install the development version of `greta.censored` from GitHub -with: +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") @@ -85,14 +91,34 @@ print(dist) ## Code of Conduct -Please note that the greta.censored project is released with a [Code of +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 in your research, please cite it -as follows: +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, +. + +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}, + } -greta.censored: Censored Distributions for `greta`. R package version -0.1.0. +Alternatively, refer to the package’s CRAN page: [greta.censored on +CRAN](https://CRAN.R-project.org/package=greta.censored).