search

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
16 stars 2 forks source link

Fix formatting so functions link #179

Closed kaitejohnson closed 2 weeks ago

kaitejohnson commented 3 weeks ago

Edited: The reason things weren't linking is just that they weren't formatted properly. Link citations only necessary if you have a bibliograph (which we don't)

dylanhmorris commented 3 weeks ago

This appears to work for me. Only issue I see in the rendered version is one instance of roxygen2-style brackets, which can be removed, since pkgdown renders backticked function calls as links by default.

https://github.com/CDCgov/ww-inference-model/blob/b51a1e24ccd7e821ce0e12d9944d54eb21b16981/vignettes/wwinference.Rmd#L419

Also, this vignette calls library(wwinference) but also has many calls of the form wwinference::function(). Those should probably just be function() since it's a vignette (either do in this PR or open an issue to do separately; your call)

kaitejohnson commented 3 weeks ago

Weird ok I will address both in this PR. @dylanhmorris Does it work when you render locally or just when you preview the package down site? (Which I have tried, and somehow still have not figured out but need to try harder..)

gvegayon commented 3 weeks ago

I don't see any citations in the vignette; what are you using that option for, @kaitejohnson?

kaitejohnson commented 3 weeks ago

I don't see any citations in the vignette; what are you using that option for, @kaitejohnson?

Despite the name, I think this is what makes function() link to the function documentation in the vignette.

github-actions[bot] commented 3 weeks ago

Thank you for your contribution, @dylanhmorris :rocket:! Your page is ready to preview here