# Facilitate Exploration of touRR optimisatioN

## Documentation for package ‘ferrn’ version 0.3.0

- DESCRIPTION file.
- Package NEWS.

## Help Pages

add_anchor | A ggproto for drawing anchor points
add_anno | A ggproto for annotating the symmetry of the starting points
add_dir_search | A ggproto for drawing directional search points
add_end | A ggproto for drawing start points
add_interp | A ggproto for drawing interpolation path
add_interp_last | A ggproto for drawing finish points
add_interrupt | A ggproto for annotating the interrupted path
add_search | A ggproto for drawing search points
add_space | A ggproto for drawing circle
add_start | A ggproto for drawing start points
add_theo | A ggproto for drawing the theoretical basis, if applicable
bind_random | Bind random bases in the projection bases space
bind_random_matrix | Bind random bases in the projection bases space as a matrix
bind_theoretical | Bind the theoretical best record
boa | Simulated sine, pipe, and gaussian mixture
boa5 | Simulated sine, pipe, and gaussian mixture
boa6 | Simulated sine, pipe, and gaussian mixture
botanical_pal | A customised colour palette based on Australian botanies
botanical_palettes | A customised colour palette based on Australian botanies
calc_smoothness | Function to calculate smoothness and squintability
calc_squintability | Function to calculate smoothness and squintability
clean_method | Clean method names
compute_pca | Helper functions for 'explore_space_pca()'
compute_projection | Plot the projection from the optimisation data collected from projection pursuit
explore_space_end | Plot the PCA projection of the projection bases space
explore_space_pca | Plot the PCA projection of the projection bases space
explore_space_start | Plot the PCA projection of the projection bases space
explore_space_tour | Plot the grand tour animation of the bases space in high dimension
explore_trace_interp | Plot the trace the search progression
explore_trace_search | Plot the count in each iteration
fit_ks | Function to calculate smoothness and squintability
fit_nls | Function to calculate smoothness and squintability
flip_sign | Helper functions for 'explore_space_pca()'
format_label | Better label formatting to avoid overlapping
GeomHuber | Create Huber plots with ggplot2
geom_huber | Create Huber plots with ggplot2
get_anchor | Functions to get components from the data collecting object
get_basis_matrix | Functions to get components from the data collecting object
get_best | Functions to get components from the data collecting object
get_dir_search | Functions to get components from the data collecting object
get_interp | Functions to get components from the data collecting object
get_interp_last | Functions to get components from the data collecting object
get_interrupt | Functions to get components from the data collecting object
get_search | Functions to get components from the data collecting object
get_search_count | Functions to get components from the data collecting object
get_space_param | Functions to get components from the data collecting object
get_start | Functions to get components from the data collecting object
get_theo | Functions to get components from the data collecting object
holes_1d_better | Data objects collected during the projection pursuit optimisation
holes_1d_geo | Data objects collected during the projection pursuit optimisation
holes_1d_jellyfish | Data objects collected during the projection pursuit optimisation
holes_2d_better | Data objects collected during the projection pursuit optimisation
holes_2d_better_max_tries | Data objects collected during the projection pursuit optimisation
holes_2d_jellyfish | Data objects collected during the projection pursuit optimisation
pipe1000 | Simulated sine, pipe, and gaussian mixture
pipe1000_10d | Simulated sine, pipe, and gaussian mixture
pipe1000_12d | Simulated sine, pipe, and gaussian mixture
pipe1000_4d | Simulated sine, pipe, and gaussian mixture
pipe1000_6d | Simulated sine, pipe, and gaussian mixture
pipe1000_8d | Simulated sine, pipe, and gaussian mixture
plot_projection | Plot the projection from the optimisation data collected from projection pursuit
prep_huber_best_proj | Create Huber plots with ggplot2
prep_space_tour | Plot the grand tour animation of the bases space in high dimension
print.basis_df | Function to calculate smoothness and squintability
print.smoothness_res | Function to calculate smoothness and squintability
print.squintability_res | Function to calculate smoothness and squintability
sample_bases | Function to calculate smoothness and squintability
scale_color_continuous_botanical | continuous scale colour function
scale_color_discrete_botanical | continuous scale colour function
scale_fill_continuous_botanical | continuous scale colour function
scale_fill_discrete_botanical | continuous scale colour function
sine1000 | Simulated sine, pipe, and gaussian mixture
sine1000_4d | Simulated sine, pipe, and gaussian mixture
sine1000_6d | Simulated sine, pipe, and gaussian mixture
sine1000_8d | Simulated sine, pipe, and gaussian mixture
StatHuber | Create Huber plots with ggplot2
stat_huber | Create Huber plots with ggplot2
tbl_sum.basis_df | Function to calculate smoothness and squintability
tbl_sum.smoothness_res | Function to calculate smoothness and squintability
tbl_sum.squintability_res | Function to calculate smoothness and squintability
theme_fern | A specific theme for trace plots
theme_huber | Create Huber plots with ggplot2