extractDf: Extract Dataframe from uncovr API Response

View source: R/extractDf.R

extractDfR Documentation

Extract Dataframe from uncovr API Response

Description

This function extracts the dataframe from the output of the buildModelData function. Please refer to the official documentation of uncovr at https://www.foyi.co.nz/posts/documentation/documentationuncovr/.

Usage

extractDf(uncovrJson)

Arguments

uncovrJson

A json. This is the output of the buildModelData function.

Details

The purpose of this function can be best understood when explained within the context that is given below. There is a closed source SaaS(Software as a Service) software named uncovr that provides an API(Application Programming Interface). In its current state, the SaaS software is free to use with some constraints around the volume of data and the frequency of API calls. One of the functions of uncovr API takes an input of number of observations i.e. rows and number of independent variables namely columns and gives an output. This output is in the form of a json file and has many other elements besides the dependent and independent variables. This function extractDf helps in extracting the dataframe from the json.

Value

A dataframe with dependent and independent variables. The independent variables are prefixed with iv and the dependent variable is named dv.


conjurer documentation built on May 1, 2022, 9:05 a.m.