Skip to content

Commit e04e33f

Browse files
committed
Makes README.Rmd so I can use programmatically variables in the resulting README.md that can be built using devtools::build_readme()
1 parent 28ad0e2 commit e04e33f

File tree

3 files changed

+99
-8
lines changed

3 files changed

+99
-8
lines changed

.Rbuildignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,7 @@
2323
^CRAN-SUBMISSION$
2424
^CITATION.cff
2525
^\.github$
26+
^README\.Rmd$
27+
^_README_cache$
28+
^README_files$
29+
^README\.md$

README.Rmd

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: "survHE"
3+
format: gfm
4+
execute:
5+
echo: false
6+
message: false
7+
warning: false
8+
output: github_document
9+
---
10+
11+
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/survHE)](https://cran.r-project.org/package=survHE)
12+
[![CRAN_Download_Badge](https://cranlogs.r-pkg.org/badges/survHE)](https://cran.r-project.org/package=survHE)
13+
[![CRAN_Download_Badge](https://cranlogs.r-pkg.org:443/badges/grand-total/survHE?color=orange)](https://cranlogs.r-pkg.org:443/badges/grand-total/survHE?color=orange)
14+
15+
## Survival analysis in health economic evaluation
16+
17+
:rocket: This is the **development version** of the `R` package `survHE` (currently at version `r packageDescription("survHE")$Version`). A "stable" version (as of `r Sys.Date() |> format("%-d %B %Y")`: `r utils::available.packages(filters = "CRAN")["survHE",2]`) is packaged and available from [CRAN](https://cran.r-project.org/web/packages/survHE/index.html).
18+
19+
Contains a suite of functions to systematise the workflow involving survival analysis in health economic evaluation. survHE can fit a large range of survival models using both a frequentist approach (by calling the R package [flexsurv](https://CRAN.R-project.org/package=flexsurv)) and a Bayesian perspective. For a selected range of models, both Integrated Nested Laplace Integration (via the R package [INLA](https://www.r-inla.org/)) and Hamiltonian Monte Carlo (via the R package [rstan](https://CRAN.R-project.org/package=rstan)) are possible. HMC models are pre-compiled so that they can run in a very efficient and fast way. In addition to model fitting, survHE provides a set of specialised functions, for example to perform Probabilistic Sensitivity Analysis, export the results of the modelling to a spreadsheet, plotting survival curves and uncertainty around the mean estimates.
20+
21+
**NB**: To run the Bayesian models, as of version 2.0 of `survHE`, it is necessary to install the additional packages [`survHEinla`](https://github.com/giabaio/survHEinla) and/or [`survHEhmc`](https://github.com/giabaio/survHEhmc), which are available from this GitHub repository. The reason for this structural change is that in this way, the basic backbone of `survHE` (available from this `main` branch of the repo) becomes a very lean package, whose installation is very quick. More details [here](https://gianluca.statistica.it/blog/2022-01-18-survhe-light/). All the functionalities are in place for `survHE` to easily extend to the Bayesian versions, once one or both of the additional "modules" is also installed.
22+
23+
## Installation
24+
The most updated version can be installed using the following code.
25+
26+
```R
27+
install.packages(
28+
"survHE",
29+
repos = c("https://giabaio.r-universe.dev", "https://cloud.r-project.org")
30+
)
31+
```
32+
33+
To run the Bayesian versions of the models, you also need to install the ancillary packages
34+
35+
```R
36+
# Bayesian models using HMC/Stan
37+
install.packages(
38+
"survHEhmc",
39+
repos = c("https://giabaio.r-universe.dev", "https://cloud.r-project.org"),
40+
dependencies=TRUE
41+
)
42+
43+
# Bayesian models using INLA
44+
install.packages(
45+
"survHEinla",
46+
repos = c(
47+
"https://giabaio.r-universe.dev",
48+
"https://cloud.r-project.org",
49+
"https://inla.r-inla-download.org/R/stable"
50+
),
51+
dependencies=TRUE
52+
)
53+
```
54+
(these two are optional, in some sense, so you don't *have* to, unless you want to do the right thing and be Bayesian about it... :wink:)

README.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,59 @@
1-
# survHE
1+
survHE
2+
================
23

34
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/survHE)](https://cran.r-project.org/package=survHE)
45
[![CRAN_Download_Badge](https://cranlogs.r-pkg.org/badges/survHE)](https://cran.r-project.org/package=survHE)
56
[![CRAN_Download_Badge](https://cranlogs.r-pkg.org:443/badges/grand-total/survHE?color=orange)](https://cranlogs.r-pkg.org:443/badges/grand-total/survHE?color=orange)
67

78
## Survival analysis in health economic evaluation
89

9-
:rocket: This is the **development version** of the `R` package `survHE`. The stable version is now release 2.0.5, on [CRAN](https://cran.r-project.org/web/packages/survHE/index.html).
10+
:rocket: This is the **development version** of the `R` package `survHE`
11+
(currently at version 2.0.51). A “stable” version (as of 11 July 2025:
12+
2.0.5) is packaged and available from
13+
[CRAN](https://cran.r-project.org/web/packages/survHE/index.html).
1014

11-
Contains a suite of functions to systematise the workflow involving survival analysis in health economic evaluation. survHE can fit a large range of survival models using both a frequentist approach (by calling the R package [flexsurv](https://CRAN.R-project.org/package=flexsurv)) and a Bayesian perspective. For a selected range of models, both Integrated Nested Laplace Integration (via the R package [INLA](https://www.r-inla.org/)) and Hamiltonian Monte Carlo (via the R package [rstan](https://CRAN.R-project.org/package=rstan)) are possible. HMC models are pre-compiled so that they can run in a very efficient and fast way. In addition to model fitting, survHE provides a set of specialised functions, for example to perform Probabilistic Sensitivity Analysis, export the results of the modelling to a spreadsheet, plotting survival curves and uncertainty around the mean estimates.
15+
Contains a suite of functions to systematise the workflow involving
16+
survival analysis in health economic evaluation. survHE can fit a large
17+
range of survival models using both a frequentist approach (by calling
18+
the R package [flexsurv](https://CRAN.R-project.org/package=flexsurv))
19+
and a Bayesian perspective. For a selected range of models, both
20+
Integrated Nested Laplace Integration (via the R package
21+
[INLA](https://www.r-inla.org/)) and Hamiltonian Monte Carlo (via the R
22+
package [rstan](https://CRAN.R-project.org/package=rstan)) are possible.
23+
HMC models are pre-compiled so that they can run in a very efficient and
24+
fast way. In addition to model fitting, survHE provides a set of
25+
specialised functions, for example to perform Probabilistic Sensitivity
26+
Analysis, export the results of the modelling to a spreadsheet, plotting
27+
survival curves and uncertainty around the mean estimates.
1228

13-
**NB**: To run the Bayesian models, as of version 2.0 of `survHE`, it is necessary to install the additional packages [`survHEinla`](https://github.com/giabaio/survHEinla) and/or [`survHEhmc`](https://github.com/giabaio/survHEhmc), which are available from this GitHub repository. The reason for this structural change is that in this way, the basic backbone of `survHE` (available from this `main` branch of the repo) becomes a very lean package, whose installation is very quick. More details [here](https://gianluca.statistica.it/blog/2022-01-18-survhe-light/). All the functionalities are in place for `survHE` to easily extend to the Bayesian versions, once one or both of the additional "modules" is also installed.
29+
**NB**: To run the Bayesian models, as of version 2.0 of `survHE`, it is
30+
necessary to install the additional packages
31+
[`survHEinla`](https://github.com/giabaio/survHEinla) and/or
32+
[`survHEhmc`](https://github.com/giabaio/survHEhmc), which are available
33+
from this GitHub repository. The reason for this structural change is
34+
that in this way, the basic backbone of `survHE` (available from this
35+
`main` branch of the repo) becomes a very lean package, whose
36+
installation is very quick. More details
37+
[here](https://gianluca.statistica.it/blog/2022-01-18-survhe-light/).
38+
All the functionalities are in place for `survHE` to easily extend to
39+
the Bayesian versions, once one or both of the additional “modules” is
40+
also installed.
1441

1542
## Installation
43+
1644
The most updated version can be installed using the following code.
17-
```R
45+
46+
``` r
1847
install.packages(
1948
"survHE",
2049
repos = c("https://giabaio.r-universe.dev", "https://cloud.r-project.org")
2150
)
2251
```
2352

24-
To run the Bayesian versions of the models, you also need to install the ancillary packages
25-
```R
53+
To run the Bayesian versions of the models, you also need to install the
54+
ancillary packages
55+
56+
``` r
2657
# Bayesian models using HMC/Stan
2758
install.packages(
2859
"survHEhmc",
@@ -41,4 +72,6 @@ install.packages(
4172
dependencies=TRUE
4273
)
4374
```
44-
(these two are optional, in some sense, so you don't *have* to, unless you want to do the right thing and be Bayesian about it... :wink:)
75+
76+
(these two are optional, in some sense, so you don’t *have* to, unless
77+
you want to do the right thing and be Bayesian about it… :wink:)

0 commit comments

Comments
 (0)