These gists are specially created to initialize uslfin users.

first_time_use_learnfin.r

#Part of the learnfin package tutorial.
#First set of experiments with (almost) default values.

####REQUIRED - CHANGE BELOW
setwd("Set this value to the path of the input parameters excel file.")
##Example MacOS, Linux setwd("~/Documents/learnfin_implementation/")
##Example Windows setwd("C:/Documents/learnfin_implementation/")

#The code below will do a series of experiments and return the summary results of those experiments. 
#Experiment parameters are taken from the input_parameters.xlsx file.
run_full_experiment(
  data_set="learnfin_ds_1",
  error_type="ARPE",
  method="kmeans",
  path_name=getwd(),
  file_name="input_parameters.xlsx",
  randseed=3456,
  verbal_feedback=TRUE,
  export_raw_results=FALSE,
  export_folder="results",
  summary_to_excel=FALSE
  )

getting_ready_learnfin.r

#Here are the steps to install learnfin R package from GitHub
#See https://learnfin.github.io for detailed information

#First, some optional but nice to have options
options(repos="http://cran.rstudio.com/") #Set default repo to CRAN
options(dplyr.width = Inf) #See all dplyr data table columns
options(scipen = 7) #Set number of digits displayed to 7

#Install devtools package for the ability to install from GitHub
#You may skip this command if you have already installed devtools
install.packages("devtools")

#Install learnfin package from its GitHub repository
devtools::install_github("learnfin/learnfin")
#Load the package
library(learnfin)

#That's it! Congratulations, you have just downloaded and installed an academic work.
#Other pages and gists will help you run the codes.