Data Explorer
This component is used by students to briefly summarize data as it is presented and perform various statistical tests.
Options
- categorical |
array
: array of strings indicating the name of each categorical variable. Default:[]
. - quantitative |
array
: array of strings indicating the name of each quantitative variable. Default:[]
. - data |
object
: data object or array to be viewed. If it is an object, the keys correspond to column values while an array will expect an array of objects with a named field corresponding to each column. If you wish to allow students the ability to import a.csv
file, set thedata
option to befalse
. Default:{}
. - dataInfo |
object
: object containing the keys \'name\', whose value is a string, \'info\', whose value is an array of strings in which each element in the array is a new line and \'variables\', an object with keys as variable names and values as variable descriptions. Default:{ 'info': '', 'name': '', 'variables': null, 'showOnStartup': false }
. - editor |
boolean
: boolean indicating whether to show the editor to the user. Default:true
. - editorProps |
object
: object of properties to be passed to theTextEditor
(see documentation for ). Default:none
. - editorTitle |
string
: string indicating the title of the explorer to be displayed. Default:none
. - dataTable |
boolean
: boolean value indicating whether to hide the data table from view. Default:true
. - dataTableProps |
object
: properties passed to the data table component (see documentation for ). Default:{}
. - history |
boolean
: controls whether to display a history log of carried out actions. Default:true
. - reportMode |
string
: controls whether to sync editor changes for everyone (collaborative
), across users in groups (group
), or not (individual
). Default:'individual'
. - histogramDensities |
boolean
: boolean value indicating whether to display histogram densities. Default:true
. - models |
array
: array of strings indicating models that may be fit on the data. Default:[ 'Simple Linear Regression', 'Multiple Linear Regression', 'LASSO', 'Decision Tree', 'Random Forest', 'Logistic Regression', 'Naive Bayes', 'PCA', 'Hierarchical Clustering', 'kmeans' ]
. - opened |
string
: page opened at startup. Default:none
. - plots |
array
: array of strings indicating which plots to show to the user. Default:[ 'Bar Chart', 'Pie Chart', 'Mosaic Plot', 'Histogram', 'Interval Plot', 'Box Plot', 'Line Plot', 'Scatterplot', 'Scatterplot Matrix', 'Heat Map', 'Contour Chart', 'Violin Plot', 'QQ Plot' ]
. - questions |
(array|object)
: array of nodes of text and question components to be displayed in aquestions
tab or an object of properties passed down to an underlying<Pages />
component. Default:none
. - showTestDecisions |
boolean
: boolean indicating whether to show the decisions made for each test based on the calculated p-values. Default:true
. - statistics |
array
: array of strings indicating which summary statistics may be calculated. Default:[ 'Mean', 'Median', 'Min', 'Max', 'Range', 'Interquartile Range', 'Standard Deviation', 'Variance', 'Correlation', 'Correlation Matrix', 'Skewness', 'Excess Kurtosis', 'First Quartile', 'Third Quartile', 'Quantile', 'Five-Number Summary' ]
. - style |
object
: CSS inline styles for main container. Default:{}
. - tables |
array
: array of strings indicating which tables may be created from the data. Default:[ 'Frequency Table', 'Contingency Table' ]
. - tabs |
array
: array of objects and keys indicating any custom tabs to add. Default:[]
. - tests |
array
: array of strings indicating which hypothesis tests to include. Default:[ 'One-Sample Mean Test', 'Two-Sample Mean Test', 'One-Way ANOVA', 'One-Sample Proportion Test', 'Two-Sample Proportion Test', 'Correlation Test', 'Chi-square Independence Test', 'Kruskal-Wallis Test' ]
. - transformer |
boolean
: boolean indicating whether to display variable transformation tools. Default:true
. - onTutorialCompletion |
function
: function invoked when user has completed the data explorer tutorial. Default:onTutorialCompletion() {}
. - onTutorialStart |
function
: function invoked when user starts the data explorer tutorial. Default:onTutorialStart() {}
.
Examples
In creating a data explorer, one needs a .json dataset. This step may be accomplished by including the following in the header of a .isle file:
require:
dataName: "./dataName.json"
Consider a dataset called "heartdisease" with the following variables:
- Gender: Categorical
- Drugs: Categorical
- Complications: Categorical
- Cost: Quantitative
- Age: Quantitative
- Interventions: Quantitative
- ERVisit: Quantitative
- Comorbidities: Quantitative
- Duration: Quantitative
We will include the explorer with the following code:
Live Editor
Result
ReferenceError: Provider is not defined