Skip to contents

Check contact survey data

Source: R/as_contact_survey.R
as_contact_survey.Rd

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 = NULL,
  year.column = NULL
)

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; if NULL (default), will use "country" column if present

year.column

the column in the participants data frame containing the year in which the participant was queried; if NULL (default), will use "year" column if present

Value

invisibly returns a character vector of the relevant columns

Examples

data(polymod)
check(polymod)
#> Warning: `check()` was deprecated in socialmixr 1.0.0.
#> ℹ Use `as_contact_survey()` instead to construct a `<contact_survey>` object.
#>   This will perform necessary checks.
#> → Check OK.