prepare_report: Summary all analysis and generate essential parts for final...

View source: R/prepare_report.R

prepare_reportR Documentation

Summary all analysis and generate essential parts for final model report

Description

After former pipeline, there are a lost of results, this function is used to tidy and summary the results for final model report.

Usage

prepare_report(
  data_wider,
  model,
  abilities,
  class_NL,
  background = NULL,
  plot_x = "Z_acd_score",
  plot_y = "wt_sum_predict"
)

Arguments

data_wider

Data.frame, with each row represent all observation of a person and his/her missing_rate, prediction. ie. the output of function wt_sum_predict

model

A lm object, with additional rw part, generated by select_by_RW.

abilities

Data.frame, including two column, the game_name and the represent ability of it.

class_NL

Data.frame, class name list, has a column indicate the name and a corresponding column indicate it's class. user_name and class

background

Data.frame or NULL, if the background is specified, it will be used in function plot_pred() to visualize the judgment standard. It should have x, y and judgment as columns.

plot_x, plot_y

String, the x axis and y axis variables used in function plot_pred()

Value

A list, contains following values:

report_rw

The tasks in model and its corresponding ability and relative weight

n_task

The number of tasks in model

r2,adj_r2

Model interpretation rate

summary_pred

The judgment and it's description and people proportion

detail_pred

The details of prediction and judgment, for every person

namelist_pred

The prediction and judgment name list for every class

namelist_drop

The name list of people those who are not involved prediction

background

The background used in plot_pred()

plot_x,plot_y

The x axis and y axis variables used in function plot_pred()


Blockhead-yj/report.iqz documentation built on March 18, 2022, 5:30 a.m.