shs_create_app_data: Process SHS survey Excel dataset, output to Rds files for use...

Description Usage Arguments Value Examples

View source: R/shs_create_app_data.R

Description

shs_create_app_data extracts data and metadata, removes unnecessary columns, renames columns and variables, processes data into the correct format, and removes local authority data from Scotland-only tables.

Usage

1
2
3
4
5
6
7
shs_create_app_data(
  destination_directory,
  source_data_directory,
  columns_to_remove,
  column_names_workbook_path,
  variable_names_workbook_path
)

Arguments

destination_directory

string. The path of the directory to save the output data to.

source_data_directory

string. The path of the directory containing source data and metadata in Excel format.

columns_to_remove

string. Unnecessary columns to remove from the dataset.

column_names_workbook_path

string. The path of an Excel file containing column renaming details.

variable_names_workbook_path

string. The path of an Excel file containing variable renaming details.

Value

null.

Examples

1
2
3
4
## Not run: 
shs_create_app_data(destination_directory, source_data_directory, column_names_workbook_path, variable_names_workbook_path, columns_to_remove)

## End(Not run)

DataScienceScotland/shsannualreport documentation built on Dec. 17, 2021, 4:07 p.m.