Render k-fold factor analysis on scale using kfa

Source: R/extensions-export_kfa_report.R

Generates a k-fold factor analysis report using the 'scale' field in the blueprintr data dictionaries. While not recommended, this function does allow for multiple loaded variables, delimited by commas. For example, 'var1' could have 'scale' be "SCALE1,SCALE2".

render_kfa_report(
  dat,
  bp,
  meta,
  scale,
  path = NULL,
  path_pattern = "reports/kfa-{snakecase_scale}-{dat_name}.html",
  format = NULL,
  title = NULL,
  ...
)

Arguments

dat

Source data

bp

The dataset's blueprint

meta

blueprintr data dictionary

scale

Scale identifier to be located in the 'scale' field

path

Where to output the report; defaults to the "reports" subfolder of the current working project folder.

path_pattern

If path is NULL, this is where the report will be saved. Variables available for use are:

  • scale: The scale name defined in the metadata

  • snakecase_scale: scale but in snake_case

  • dat_name: Name of the dataset (equivalent to the blueprint name)

format

The output format; defaults to 'html_document'

title

Optional title of the report

...

Arugments forwarded kfa::kfa()

Value

Path to where the generated report is saved