as_contact_survey: Check contact survey data

In sbfnk/socialmixr: Social Mixing Matrices for Infectious Disease Modelling

Check contact survey data

Description

Checks that a survey fulfills all the requirements to work with the 'contact_matrix' function

Usage

as_contact_survey(
  x,
  id.column = "part_id",
  country.column = "country",
  year.column = "year"
)

Arguments

x	list containing an element named 'participants', a data frame containing participant information an element named 'contacts', a data frame containing contact information (optionally) an element named 'reference, a list containing information information needed to reference the survey, in particular it can contain$a "title", "bibtype", "author", "doi", "publisher", "note", "year"
id.column	the column in both the participants and contacts data frames that links contacts to participants
country.column	the column in the participants data frame containing the country in which the participant was queried
year.column	the column in the participants data frame containing the year in which the participant was queried

Value

invisibly returns a character vector of the relevant columns

Examples

data(polymod)
check(polymod)

sbfnk/socialmixr documentation built on Feb. 26, 2025, 8:55 p.m.