Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
seabbs committed Aug 21, 2024
1 parent b5e121f commit 858833e
Show file tree
Hide file tree
Showing 4 changed files with 940 additions and 8 deletions.
7 changes: 5 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
Package: primarycensoreddist
Title: Censored Distributions in R and Stan
Title: Primary Event Censored Distributions in R and Stan
Version: 0.0.0.1000
Authors@R:
person("Sam Abbott", , , "contact@samabbott.co.uk", role = c("aut", "cre"),
comment = c(ORCID = "0000-0001-8057-8037"))
Description: Censored distributions in R and Stan.
Description: This package provides both R functions for working with primary
event censored distributions and Stan implementations for use in Bayesian
modeling. Primary event censored distributions are useful for modeling
delayed reporting scenarios in epidemiology and other fields.
License: MIT + file LICENSE
URL: https://primarycensoreddist.epinowcast.org,
https://github.com/epinowcast/primarycensoreddist/
Expand Down
8 changes: 2 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,7 @@ license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/

## Summary

```{r, results = "asis", echo=FALSE}
cat(gsub("\n[ ]+", " ", packageDescription("primarycensoreddist")$Description))
```

This package provides both R functions for working with censored distributions and Stan implementations for use in Bayesian modeling. It offers a flexible framework for handling various types of censoring in both R and Stan environments.
This package provides both R functions for working with primary event censored distributions and Stan implementations for use in Bayesian modeling. Primary event censored distributions are useful for modeling delayed reporting scenarios in epidemiology and other fields.

## Installation

Expand Down Expand Up @@ -104,7 +100,7 @@ Please briefly describe your problem and what output you expect in an [issue](ht

### Code of Conduct

Please note that the `epinowcast` project is released with a [Contributor Code of Conduct](https://github.com/epinowcast/.github/blob/main/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
Please note that the `primarycensoreddist` project is released with a [Contributor Code of Conduct](https://github.com/epinowcast/.github/blob/main/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.

## Citation

Expand Down
Loading

0 comments on commit 858833e

Please sign in to comment.