sampcompR (version 0.3.0)

biv_compare_table: Returns a table based on the information of a biv_compare_object which can be outputted as HTML or LaTex Table, for example with the help of the stargazer function.

Description

Returns a table based on the information of a biv_compare_object which can be outputted as HTML or LaTex Table, for example with the help of the stargazer function.

Usage

biv_compare_table(
  biv_compare_object,
  type = "diff",
  comparison_number = 1,
  ndigits = 2
)

Value

A correlation matrix, or difference matrix based on information of a biv_compare_object.

Arguments

biv_compare_object

A object returned by the biv_compare function.

type

A character string, to choose what matrix should be printed.

• If "dfs", a correlation matrix of all variables of comparison in the chosen dataframe will be returned.

• If "benchmarks", a correlation matrix of all variables of comparison in the chosen benchmark will be returned.

• if "diff", a matrix indicating the difference between the chosen dataframe and benchmark will be returned.

comparison_number

A number indicating the data of which data frame, benchmark or comparison should be displayed. The maximum length is equal to the length of the dfs vector that is used to generate the biv_compare_object.

ndigits

Number of digits shown in the table.

Examples

## Get Data for comparison

data("card")

north <- card[card$south==0,]
white <- card[card$black==0,]

## use the function to plot the data 
bivar_data<-sampcompR::biv_compare(dfs = c("north","white"),
                                   benchmarks = c("card","card"),
                                   variables= c("age","educ","fatheduc","motheduc","wage","IQ"),
                                   data=TRUE)
                        
table<-sampcompR::biv_compare_table(bivar_data, type="diff", comparison_number=1)
noquote(table)