export_pi_summary: Export the preference index to a csv file

View source: R/export.R

export_pi_summaryR Documentation

Export the preference index to a csv file

Description

Export the preference index to a csv file

Usage

export_pi_summary(
  experiment_folder,
  pi,
  result_folder = NULL,
  output_csv = NULL,
  suffix = ""
)

Arguments

experiment_folder

Path to folder containing IDOC results .csv files

pi

Dataframe to be exported. Should contain a column named preference_index

result_folder

Path to a folder where to save results. If not passaed, it is set to experiment_folder

output_csv

Path of csv output. If not provided, a new file in the experiment folder with key SUMMARY is produced

suffix

A character (word) that will differentiate resulting output from other output produced on the same experiment folder. Useful for segmenting the experiment into different periods of interest and analyzing these periods separately.


shaliulab/idocr documentation built on June 1, 2025, 4:59 p.m.