read_xls_form: Load XLS Form file

Description Usage Arguments Details Value

View source: R/load_form.R

Description

read_xls_form loads an XLS Form and its accompanying data into R.

Usage

1
2
3
4
5
6
7
read_xls_form(
  filepath,
  survey = "survey",
  choices = NULL,
  data = NULL,
  cleaning = NULL
)

Arguments

filepath

Path to the XLS Form

survey

Name of the survey worksheet, Default: 'survey'

choices

Name of the choices worksheet, optional, Default: 'choices';

data

Name of the data worksheet, Default: 'data'

cleaning

Name of the cleaning worksheet, Default: 'cleaning'

Details

This function loads XLS Form Excel files into R, while also allowing additional sheets for exported data and cleaning. It's loaded as an S3 class kobold, and can be worked with using functions within this package, or the data can be retrieved as a data frame or tibble using generics. The columns of the data are given a class according to the survey and choices sheet.

Value

Returns a kobold class object, a modified list containing the above data frames.


caldwellst/kobold documentation built on April 28, 2020, 12:48 a.m.