get_portal_app_data: Get current data for Data Portal products with R generated...

Description Usage Arguments

View source: R/get_portal_app_data.R

Description

Most if not all Data Portal applications are dependent upon datasets tailored to each application's needs.

It is the policy of the Data Portal team that data for such data-dependent applications must be generated either as part of Data Portal SQL loading or by R processes defined in the pocr package.

This is the wrapper that generates current data for Data Portal products using R generated data. It is intended to be the first stage of the data update process for these products.

The user specifies which applications should receive a data update (the function defaults to updating all supported applications) and the wrapper performs the necessary steps to:

  1. Prepare data sources

  2. Gather updated data

  3. Process updated data to application specifications

  4. Write processed data to a local directory, named after the repo

The steps are performed application-by-application, with each application having its own wrapper and suite of functions to handle its specific needs.

On successful completion, the user should manually inspect the generated data. If it appears correct, the data should then be manually integrated into each application's repo.

Usage

1
2
get_portal_app_data(target_apps = "all", excluded_apps = NULL,
  annie_connection = "annie", poc_connection = "POC")

Arguments

target_apps

A string vector of application names to update. The names match the pocdata repo names on GitHub. Defaults to "all" which updates all supported applications.

excluded_apps

A string vector of application names to avoid updating. Useful if you want to update most - but not all - applications. Defaults to NULL.

annie_connection

An active RODBC connection to the "test_annie" MySQL server or a character string that can be passed to RODBC::odbcConnect() to create an active RODBC connection to that server.

poc_connection

An active RODBC connection to the "POC" SQL server or a character string that can be passed to RODBC::odbcConnect() to create an active RODBC connection to that server.


pocdata/pocr documentation built on Jan. 5, 2022, 9:54 a.m.