Skip to content

Commit

Permalink
Updated README to have a link to the preprint. Updated pre-print to r… (
Browse files Browse the repository at this point in the history
#55)

* Updated README to have a link to the preprint. Updated pre-print to reflect the changes to extract_estimates.

* Changed URL to be doi link rather than bioarXiv as the former will update with versions on bioarXiv while the latter was version tagged.

* Moved pre-print PDF to inst/doc/ and updated README to reflect that change. Added badge to README that links to the DOI.

* Removed inst/doc/ from the .gitignore file.
  • Loading branch information
Tess-LaCoil authored Jan 23, 2025
1 parent 24884ae commit c06e858
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ po/*~
# RStudio Connect folder
rsconnect/

inst/doc
/doc/
/Meta/

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,17 @@
coverage](https://codecov.io/gh/traitecoevo/hmde/branch/master/graph/badge.svg)](https://app.codecov.io/gh/traitecoevo/hmde?branch=master)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![DOI:
10.1101/2025.01.15.633280](https://img.shields.io/badge/DOI%3A-10.1101%2F2025.01.15.633280-blue?link=https%3A%2F%2Fdoi.org%2F10.1101%2F2025.01.15.633280)](https://doi.org/10.1101/2025.01.15.633280)
<!-- badges: end -->


The goal of hmde is to fit a model for the rate of change in some quantity based on a set of pre-defined functions arising from ecological applications. We estimate differential equation parameters from repeated observations of a process, such as growth rate parameters to data of sizes over time.
In other language, `hmde` implements hierarchical Bayesian longitudinal models to solve the Bayesian inverse problem of estimating differential equation parameters based on repeat measurement surveys. Estimation is done using Markov Chain Monte Carlo, implemented through
[Stan](https://mc-stan.org/) via [RStan](https://mc-stan.org/users/interfaces/rstan), built under [R](https://cran.r-project.org/) 4.3.3. The inbuilt models are based on case studies in ecology.

A pre-print paper is available on [bioarXiv](https://doi.org/10.1101/2025.01.15.633280), or as the [hmde_paper.pdf](https://github.com/traitecoevo/hmde/blob/master/inst/doc/hmde_paper.pdf) file here.

## The Maths

The general use case is to estimate a vector of parameters $\boldsymbol{\theta}$ for a chosen differential equation
Expand Down
Binary file renamed hmde_paper.pdf → inst/doc/hmde_paper.pdf
Binary file not shown.

0 comments on commit c06e858

Please sign in to comment.