Skip to content

Commit

Permalink
futher edits
Browse files Browse the repository at this point in the history
  • Loading branch information
hillalex committed Oct 24, 2024
1 parent 6779222 commit ef47492
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions vignettes/data.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "A guide to model input and output data"
title: "A guide to biokinetics input and output data"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{A guide to model input and output data}
%\VignetteIndexEntry{A guide to biokinetics input and output data}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
Expand All @@ -17,7 +17,7 @@ knitr::opts_chunk$set(
# Input data

The model requires time series data about individual titre readings, along with last exposure times. Times can be relative (e.g. day of study) or absolute (i.e. precise calendar dates).
The full list of required columns is as follows:
This is provided via the `data` argument when initialising an object of class [biokinetics](../reference/biokinetics.html), which must be a [data.table](https://rdatatable.gitlab.io/data.table/reference/data.table.html) containing the following columns:

| name | type | description | required |
|--------------|----------------------|--------------------------------------------------------------------------------------------| -------- |
Expand Down Expand Up @@ -52,7 +52,7 @@ that users who are already familiar with `cmdstanr` are free to do what they wan
directly with the fitted `CmdStanMCMC` all values will be on this scale. The package provides a helper function for converting
back to the original scale: [convert_log2_scale_inverse](../reference/convert_log2_scale_inverse.html).**

Three further functions provide model outputs that we think are particularly useful in [data.table](https://cran.r-project.org/web/packages/data.table/) format.
Three further functions provide model outputs that we think are particularly useful in [data.table](https://rdatatable.gitlab.io/data.table/reference/data.table.html) format.
[biokinetics](../reference/biokinetics.html) contains documentation on each of these functions so please read that first; this vignette provides
guidance on the correct interpretation of each column in the returned tables (in these functions data is returned on the original scale).

Expand Down

0 comments on commit ef47492

Please sign in to comment.