Commit f8db8097 authored by Chris Jewell's avatar Chris Jewell
Browse files

Added roxygen2-generated doc files for data structures.

parent a5c15624
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/data.R
\name{Prev}
\alias{Prev}
\title{Constructs prevalence data}
\usage{
Prev(data, prev, source, time = NULL)
}
\arguments{
\item{data}{long-format data.frame containing prevalence data by
source and time.}
\item{prev}{character string giving name of prevalence column in data}
\item{source}{character string giving name of source column in data}
\item{time}{optional column denoting times of prevalence observation}
}
\value{
A Prev data structure for use in sourceR models
}
\description{
The Prev constructor function returns an R6 Prevalence class
which feeds data into sourceR models.
}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/data.R
\name{X}
\alias{X}
\title{Constructs source data}
\usage{
X(data, x, type, source, time = NULL)
}
\arguments{
\item{data}{long-format data.frame containing source data}
\item{x}{character string giving name of source counts column in data}
\item{type}{character string giving name of type column in data}
\item{source}{character string giving name of source column in data}
\item{time}{optional column denoting times of source observation}
}
\value{
A X source data structure for use in sourceR models
}
\description{
The X constructor function returns an R6 X class
which feeds source data into sourceR models.
}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/data.R
\name{Y}
\alias{Y}
\title{Constructs disease count data}
\usage{
Y(data, y, type, time = NULL, location = NULL)
}
\arguments{
\item{data}{long-format data.frame containing source data}
\item{y}{character string giving name of disease counts column in data}
\item{type}{character string giving name of type column in data}
\item{time}{optional column denoting times of disease count observations}
\item{location}{optional column denoting location of disease count observations}
}
\value{
A Y disease count data structure for use in sourceR models
}
\description{
The Y constructor function returns an R6 Y class
which feeds disease count data into sourceR models.
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment