surveySmallValues: Report the values lower than a specified value per specified...

In PYannick/HighFrequencyChecks: High Frequency Checks

Description

This function provide a report showing all values which are lower than a certain threshold for a specified list of fields.

Usage

surveySmallValues(
  ds = NULL,
  questionsSurveySmallValues = NULL,
  enumeratorID = NULL,
  reportingColumns = c(enumeratorID, uniqueID),
  enumeratorCheck = FALSE
)

Arguments

ds	dataset containing the survey (from kobo): data.frame
questionsSurveySmallValues	columns name from the dataset and value you want to check against (c(col1=value1,col2=value2,...)): named list of integer
enumeratorID	name of the field where the enumerator ID is stored: string
reportingColumns	(Optional, by default it is built from the enumeratorID and the UniqueID) name of the columns from the dataset you want in the result: list of string (c('col1','col2',...))
enumeratorCheck	(Optional, by default set to FALSE) specify if the report has to be displayed for each enumerator or not: boolean (TRUE/FALSE)
uniqueID	name of the field where the survey unique ID is stored: string

Value

dst same dataset as the inputed one but with survey marked for deletion if errors are found and delete=TRUE (or NULL)

ret_log list of the errors found (or NULL)

var a list of value (or NULL)

graph graphical representation of the results (or NULL)

Author(s)

Yannick Pascaud

Examples

{
ds <- HighFrequencyChecks::sample_dataset
questionsSurveySmallValues <-c(consent_received.food_security.spend_food=25000,
                             consent_received.food_security.spend_medication=25000,
                             consent_received.food_security.spend_education=25000,
                             consent_received.food_security.spend_fix_shelter=25000,
                             consent_received.food_security.spend_clothing=25000,
                             consent_received.food_security.spend_hygiene=25000,
                             consent_received.food_security.spend_fuel=25000,
                             consent_received.food_security.spend_hh_items=25000,
                             consent_received.food_security.spend_transport=25000,
                             consent_received.food_security.spend_communication=25000,
                             consent_received.food_security.spend_tobacco=25000,
                             consent_received.food_security.spend_rent=25000,
                             consent_received.food_security.spend_debts=25000,
                             consent_received.food_security.spend_other=25000)
enumeratorID <- "enumerator_id"
uniqueID <- "X_uuid"
reportingColumns <- c(enumeratorID, uniqueID)

list[dst,ret_log,var,graph] <- surveySmallValues(ds=ds,
                                       questionsSurveySmallValues=questionsSurveySmallValues,
                                       enumeratorID=enumeratorID,
                                       reportingColumns=reportingColumns,
                                       enumeratorCheck=FALSE)
head(ret_log,10)
}

PYannick/HighFrequencyChecks documentation built on Dec. 31, 2020, 3:26 p.m.