CDCgov / ww-inference-model

An in-development R package and a Bayesian hierarchical model jointly fitting multiple "local" wastewater data streams and "global" case count data to produce nowcasts and forecasts of both observations
https://cdcgov.github.io/ww-inference-model/
Apache License 2.0
17 stars 2 forks source link

Add links to package functions in vignettes #171

Closed kaitejohnson closed 1 month ago

kaitejohnson commented 2 months ago

Both spatial vignette and main could use this. I tried using [pkg::function()] but it didn't work properly. Might need to use \link[pkg]{function}?

athowes commented 2 months ago

I think that pkg::function() should work btw (seems to work for me -- see e.g. https://epidist.epinowcast.org/articles/ebola.html#model-fitting)

kaitejohnson commented 2 months ago

Ok odd, I see here that you do what we do (function_name()) but the link does work in your vignette: https://github.com/epinowcast/epidist/blob/bc10a37f7e0d4d1b7b2901158da275e5ab2a8d14/vignettes/ebola.Rmd#L202 ... Unless I should be looking at something different!

athowes commented 2 months ago

Yeah odd. Hmm:

---
title: "Getting started with wwinference"
description: "A quick start example demonstrating the use of wwinference to jointly fit wastewater and hospital admissions data"
author: "Kaitlyn Johnson"
date: "2024-06-27"
output:
  bookdown::html_vignette2:
    fig_caption: yes
    code_folding: show
pkgdown:
  as_is: true
vignette: >
  %\VignetteIndexEntry{Getting started with wwinference}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---
---
title: "Using epidist to estimate delay between symptom onset and positive test for an Ebola outbreak in Sierra Leone"
description: "A more detailed guide to using the epidist R package"
output: 
  bookdown::html_document2:
    fig_caption: yes
    code_folding: show
    number_sections: true
pkgdown:
  as_is: true
# csl: https://raw.githubusercontent.com/citation-style-language/styles/master/apa-numeric-superscript-brackets.csl
link-citations: true
vignette: >
  %\VignetteIndexEntry{Getting in depth with epidist}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
bibliography: references.bib
---

Maybe try some of these? link-citations sounds plausible.

kaitejohnson commented 2 months ago

Thats what I was thinking too... will give it a try. I would think that would have to do with the bib but maybe not...

athowes commented 2 months ago

I don't think it'd be to do with the .bib

kaitejohnson commented 2 months ago

It doesn't work when I render locally will do some investigation