Referential: Referential class is a class to load, check and manipulate...

In unhcr-americas/surveyDesigner: A Shiny App to help in the survey integration process

Referential class is a class to load, check and manipulate the XLSForm

Description

Referential class is a class to load, check and manipulate the XLSForm

Referential class is a class to load, check and manipulate the XLSForm

Public fields

data

named list for the referential file

by_groups

survey modules separated by begin and end to manipulate data

path

path for the xlsx file

Methods

Public methods

• Referential$new()

• Referential$get_groups()

• Referential$clone()

---

Method new()

read the xlsx for each sheet and return a named list

Usage

Referential$new(path)

Arguments

path

path to the file with the full referential

Returns

named list

Examples

ref <- Referential$new(
  path = system.file("SurveyDesigner_Referential.xlsx", package = "surveyDesigner") 
)

head(ref$data$survey)

# Example by groups
ref$by_groups$group_intro

---

Method get_groups()

get data by groups of begin and end

Usage

Referential$get_groups()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Referential$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `Referential$new`
## ------------------------------------------------

ref <- Referential$new(
  path = system.file("SurveyDesigner_Referential.xlsx", package = "surveyDesigner") 
)

head(ref$data$survey)

# Example by groups
ref$by_groups$group_intro

unhcr-americas/surveyDesigner documentation built on Sept. 29, 2023, 9:13 p.m.