# Lean Analytics and Robust Exploration Sidekick

## Documentation for package ‘lares’ version 5.4.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A B C D E F G H I J L M N O P Q R S T U V W X Y Z misc

lares-package | Lean Analytics and Robust Exploration Sidekick

## -- A --

are_binary | Validate inputs (attributions, options, ...)
are_constant | Validate inputs (attributions, options, ...)
are_id | Validate inputs (attributions, options, ...)
autoline | New Line Feed for Long Strings (Wrapper)

## -- B --

balance_data | Balance Binary Data by Resampling: Under-Over Sampling
bind_files | Bind Files into Dataframe
bring_api | Get API (JSON) and Transform into data.frame

## -- C --

cache_clear | Cache Save and Load (Write and Read)
cache_exists | Cache Save and Load (Write and Read)
cache_pipe | Cache Save and Load (Write and Read)
cache_read | Cache Save and Load (Write and Read)
cache_write | Cache Save and Load (Write and Read)
cal_split | Split ICS File
categ_reducer | Reduce categorical values
check_attr | Validate inputs (attributions, options, ...)
check_opts | Validate inputs (attributions, options, ...)
chr2date | Check character values for date/numeric/logical and change datatype
chr2logical | Check character values for date/numeric/logical and change datatype
chr2num | Check character values for date/numeric/logical and change datatype
ci_lower | Lower/Upper Confidence Intervals
ci_upper | Lower/Upper Confidence Intervals
ci_var | Confidence Intervals on Dataframe
cleanNames | Clean text strings automatically
cleanText | Clean text strings automatically
clusterKmeans | Automated K-Means Clustering + PCA/t-SNE
clusterOptimalK | Visualize K-Means Clusters for Several K Methods
clusterVisualK | Visualize K-Means Clusters for Several K
conf_mat | Confussion Matrix
corr | Correlation table
corr_cross | Ranked cross-correlation across all variables
corr_var | Correlation between variable and dataframe
cran_logs | Download and plot daily downloads of CRAN packages
crosstab | Weighted Cross Tabulation

## -- D --

daily_portfolio | Build a Personal Investing Portfolio Report
daily_stocks | Build a Personal Investing Portfolio Report
dalex_explainer | DALEX Explainer for H2O
dalex_local | DALEX Local
dalex_residuals | DALEX Residuals
dalex_variable | DALEX Partial Dependency Plots (PDP)
date_cuts | Convert Date into Year + Cut
date_feats | One Hot Encoding for Date/Time Variables (Dummy Variables)
db_download | Download/Import Dropbox File by File's Name
db_upload | Upload Local Files to Dropbox
dfr | Results for AutoML Predictions
dft | Titanic Dataset
df_str | Dataset columns and rows structure
dist2d | Distance from specific point to line
distr | Compare Variables with their Distributions
dont_sleep | Prevent Computer from Sleeping by Simulating Mouse Activity
dont_sleep_time | Prevent Computer from Sleeping by Simulating Mouse Activity

## -- E --

encrypt_file | File Encryption and Decryption (AES-256-CBC)
errors | Calculate Continuous Values Errors
etf_sector | ETF's Sectors Breakdown
export_plot | Export ggplot2, gridExtra, or any plot object into rendered file
export_results | Export h2o_automl's Results

## -- F --

fb_accounts | Facebook Ad Accounts
fb_ads | Facebook Ads API
fb_creatives | Facebook Creatives API
fb_insights | Facebook Insights API
fb_process | Paginate and Process Facebook's API Results
fb_report_check | Facebook API Report Status Check
fb_rf | Facebook Reach and Frequency API
fb_token | Facebook's Long-Life User API Token
filesGD | Google Drive Files (API v4)
files_functions | List all functions used in R script files by package
file_name | Extract file raw name and type from file names
file_type | Extract file raw name and type from file names
font_exists | Check if Font is Installed
forecast_arima | ARIMA Forecast
formatColoured | Print Coloured Messages
formatHTML | Format a string text as markdown/HTML
formatNum | Format a string text as markdown/HTML
freqs | Frequencies Calculations and Plot
freqs_df | Plot for All Frequencies on Dataframe
freqs_list | Frequencies on Lists and UpSet Plot
freqs_plot | Combined Frequencies Plot for Categorical Features

## -- G --

gain_lift | Cumulative Gain, Lift and Response
gemini_ask | Gemini API Interaction with R
gemini_image | Gemini API Interaction with R
get_credentials | Load Credentials from a YML File
get_creds | Load Credentials from a YML File
get_currency | Download Historical Currency Exchange Rate
get_tweets | Get Tweets
gg_colour_customs | Custom fill, colour and text colours for ggplot2
gg_fill_customs | Custom fill, colour and text colours for ggplot2
gg_text_customs | Custom fill, colour and text colours for ggplot2
gg_vals | Custom fill, colour and text colours for ggplot2
glued | Interpolate a string [glue wrapper]
gpt_ask | ChatGPT API Interaction with R
gpt_classify | ChatGPT API Interaction with R
gpt_convert | ChatGPT API Interaction with R
gpt_extract | ChatGPT API Interaction with R
gpt_format | ChatGPT API Interaction with R
gpt_history | ChatGPT API Interaction with R
gpt_prompter | Structured Prompt Builder for LLM (ChatGPT)
gpt_table | ChatGPT API Interaction with R
gpt_tag | ChatGPT API Interaction with R
gpt_translate | ChatGPT API Interaction with R
grepl_letters | Pattern Matching for Letters considering Blanks
grepm | Pattern Matching for Any or All Multiple Matches
gtrends_related | Google Trends: Related and Time Plots
gtrends_time | Google Trends: Related and Time Plots

## -- H --

h2o_automl | Automated H2O's AutoML
h2o_explainer | DALEX Explainer for H2O
h2o_predict_API | Calculate predictions of h2o Models
h2o_predict_binary | Calculate predictions of h2o Models
h2o_predict_model | Calculate predictions of h2o Models
h2o_predict_MOJO | Calculate predictions of h2o Models
h2o_results | Automated H2O's AutoML Results
h2o_selectmodel | Select Model from h2o_automl's Leaderboard
h2o_shap | SHAP values for H2O Models
haveInternet | Internet Connection Check
hex_to_raw | File Encryption and Decryption (AES-256-CBC)
holidays | Holidays in your Country

## -- I --

image_metadata | Get Meta Data from Image Files
importxlsx | Import Excel File with All Its Tabs
impute | Impute Missing Values (using MICE)
install_recommended | Install/Update Additional Recommended Libraries
ip_data | Scrap data based on IP address
is_even | Validate inputs (attributions, options, ...)
is_ip | Validate inputs (attributions, options, ...)
is_odd | Validate inputs (attributions, options, ...)
is_url | Validate inputs (attributions, options, ...)
iter_seeds | Iterate Seeds on AutoML

## -- J --

json2vector | Convert Python JSON string to R vector (data.frame with 1 row)

## -- L --

lares | Lean Analytics and Robust Exploration Sidekick
lares-exports | Pipe operator
lares_logo | Print lares R library Logo
lares_pal | Personal Colours Palette
lasso_vars | Most Relevant Features Using Lasso Regression
left | Left or Right N characters of a string
listfiles | List files in a directory
list_cats | List categorical values for data.frame
loglossBinary | Logarithmic Loss Function for Binary Models

## -- M --

mae | Calculate Continuous Values Errors
mail_send | Send Emails with Attachments (POST)
mape | Calculate Continuous Values Errors
markdown2df | Convert markdown string tables to data.frame
maze_gridsearch | Maze Solver, inspired by Micromouse competitions
maze_solve | Maze Solver, inspired by Micromouse competitions
missingness | Calculate and Visualize Missingness
model_metrics | Model Metrics and Performance
model_preprocess | Automate Data Preprocess for Modeling
move_files | Move files from A to B
mp3_get | Download MP3 from URL
mp3_trim | Trim MP3 Audio File
mp3_update_tags | Update MP3 Metadata Tags
mplot_conf | Confussion Matrix Plot
mplot_cuts | Cuts by quantiles for score plot
mplot_cuts_error | Cuts by quantiles on absolute and percentual errors plot
mplot_density | Density plot for discrete and continuous values
mplot_full | MPLOTS Score Full Report Plots
mplot_gain | Cumulative Gain Plot
mplot_importance | Variables Importances Plot
mplot_lineal | Linear Regression Results Plot
mplot_metrics | Model Metrics and Performance Plots
mplot_response | Cumulative Response Plot
mplot_roc | ROC Curve Plot
mplot_splits | Split and compare quantiles plot
mplot_topcats | Top Hit Ratios for Multi-Classification Models
mse | Calculate Continuous Values Errors
msplit | Split a dataframe for training and testing sets
myip | What's my IP?

## -- N --

ngrams | Build N-grams and keep most frequent
noPlot | Plot Result with Nothing to Plot
normalize | Normalize Vector
numericalonly | Remove/Drop Columns in which ALL or SOME values are NAs
num_abbr | Abbreviate or dis-abbreviate numerical values

## -- O --

ohe_commas | One Hot Encoding for a Vector with Comma Separated Values
ohse | One Hot Smart Encoding (Dummy Variables)
outlier_tukey | Outliers: Tukey’s fences
outlier_turkey | Outliers: Tukey’s fences
outlier_zscore | Outliers: Z-score method
outlier_zscore_plot | Outliers: Z-score method plot

## -- P --

plot.corr_var | Correlation between variable and dataframe
plot.h2o_automl | Automated H2O's AutoML
plot.h2o_shap | SHAP values for H2O Models
plot.robyn_modelselector | Robyn: Model Selection by Weighted Criteria Scores
plot.stocks_hist | Download Stocks Historical and Current Values
plot.x2y | Ranked Predictive Power of Cross-Features (x2y)
plot.x2y_preds | Ranked Predictive Power of Cross-Features (x2y)
plot_cats | Plot All Categorical Features (Frequencies)
plot_chord | Chords Plot
plot_df | Plot Summary of Numerical and Categorical Features
plot_nums | Plot All Numerical Features (Boxplots)
plot_palette | Plot Palette Colours
plot_survey | Visualize Survey Results
plot_timeline | Plot timeline as Gantt Plot
print.h2o_automl | Automated H2O's AutoML
print.maze_solve | Maze Solver, inspired by Micromouse competitions
print.robyn_crossmmm | Cross-MMM Budget Optimization across Models
print.wordle_check | Wordle Game Validation
print.wordle_simulation | Wordle Game Validation
prophesize | Facebook's Prophet Forecast

## -- Q --

quants | Calculate cuts by quantiles
queryDB | PostgreSQL Queries on Database (Read)
queryGA | Queries on Google Analytics
quiet | Quiet prints and verbose noise

## -- R --

raw_to_hex | File Encryption and Decryption (AES-256-CBC)
read.file | Read Files Quickly (Auto-detected)
readGS | Google Sheets Reading and Writing (API v4)
readGS4 | Google Sheets Reading and Writing (API v4)
read_encrypted | File Encryption and Decryption (AES-256-CBC)
reduce_pca | Reduce Dimensionality with PCA
reduce_tsne | Reduce Dimensionality with t-SNE
removenacols | Remove/Drop Columns in which ALL or SOME values are NAs
removenarows | Remove/Drop Columns in which ALL or SOME values are NAs
remove_stopwords | Remove stop-words and patterns from character vector
replaceall | Replace Values With
replacefactor | Replace Factor Values
right | Left or Right N characters of a string
rmse | Calculate Continuous Values Errors
robyn_hypsbuilder | Robyn: Generate default hyperparameters
robyn_marginal | Robyn: Marginal Performance (mROAS & mCPA) [Experimental]
robyn_modelselector | Robyn: Model Selection by Weighted Criteria Scores
robyn_performance | Robyn: Dynamic Performance and Contribution Report
robyn_xchannels | Cross-MMM Budget Optimization across Models
robyn_xmodels | Cross-MMM Budget Optimization across Models
ROC | AUC and ROC Curves Data
rsq | Calculate Continuous Values Errors
rsqa | Calculate Continuous Values Errors
rtistry_sphere | Generative Art: Sphere XmodY

## -- S --

scale_x_abbr | Axis scales format
scale_x_comma | Axis scales format
scale_x_dollar | Axis scales format
scale_x_formatNum | Axis scales format
scale_x_percent | Axis scales format
scale_y_abbr | Axis scales format
scale_y_comma | Axis scales format
scale_y_dollar | Axis scales format
scale_y_formatNum | Axis scales format
scale_y_percent | Axis scales format
scrabble_dictionary | Scrabble: Dictionaries
scrabble_points | Scrabble: Dictionaries
scrabble_score | Scrabble: Dictionaries
scrabble_words | Scrabble: Dictionaries
sentimentBreakdown | Sentiment Breakdown on Text
seq_surnames | Surnames Order Sequence
shap_var | SHAP-based dependence plots for categorical/numerical features (PDP)
slackSend | Send Slack Message (Webhook)
splot_change | Investing Portfolio Reporting Plots
splot_divs | Investing Portfolio Reporting Plots
splot_etf | Investing Portfolio Reporting Plots
splot_growth | Investing Portfolio Reporting Plots
splot_roi | Investing Portfolio Reporting Plots
splot_summary | Investing Portfolio Reporting Plots
splot_types | Investing Portfolio Reporting Plots
spread_list | Spread list column into new columns
statusbar | Progressive Status Bar (Loading)
stocks_file | Build a Personal Investing Portfolio Report
stocks_hist | Download Stocks Historical and Current Values
stocks_obj | Build a Personal Investing Portfolio Report
stocks_quote | Download Stocks Historical and Current Values
stocks_report | Build a Personal Investing Portfolio Report
sudoku_solver | Solve Sudoku Puzzles

## -- T --

target_set | Set Target Value in Target Variable
textCloud | Wordcloud Plot
textFeats | Create features out of text
textTokenizer | Tokenize Vectors into Words
theme_lares | Theme for ggplot2 (lares)
tic | Stopwatch to measure timings in R
toc | Stopwatch to measure timings in R
toon_reduction | Calculate Character Reduction from R Object to TOON Format
topics_rake | Keyword/Topic identification using RAKE
tree_var | Recursive Partitioning and Regression Trees
trendsRelated | Google Trends: Related and Time Plots
trendsTime | Google Trends: Related and Time Plots
try_require | Check if Specific Package is Installed

## -- U --

updateLares | Update the library (dev or CRAN version)

## -- V --

v2t | Convert a vector into a comma separated text
vector2text | Convert a vector into a comma separated text

## -- W --

warnifnot | Test the Truth of R Expressions and Warn
weighted_value | Calculate weighted stock values using FIFO/LIFO
what_size | Calculate the size of any R object or directory
winsorize | Outliers: Winsorize
wordle_check | Wordle Game Validation
wordle_dictionary | Wordle Game Validation
wordle_simulation | Wordle Game Validation
writeGS | Google Sheets Reading and Writing (API v4)
writeGS4 | Google Sheets Reading and Writing (API v4)
write_encrypted | File Encryption and Decryption (AES-256-CBC)

## -- X --

x2y | Ranked Predictive Power of Cross-Features (x2y)
x2y_metric | Ranked Predictive Power of Cross-Features (x2y)
x2y_preds | Ranked Predictive Power of Cross-Features (x2y)

## -- Y --

year_month | Convert Date into Year-Month, Year-Quarter or Year-Week Format
year_quarter | Convert Date into Year-Month, Year-Quarter or Year-Week Format
year_week | Convert Date into Year-Month, Year-Quarter or Year-Week Format

## -- Z --

zerovar | Zero Variance Columns

## -- misc --

%>% | Pipe operator