R/make_rotation_table.R

In rforbiodatascience22/Twenty: Twenty, A data manipulation package created by the members of group number 20

# The Rotation Table from Principal Components analysis 
#'
#' Create a rotation table from a modelled PCA object. 
#' @param pca_fit This is a model object. 
#' @importFrom magrittr %>%
#' @importFrom broom tidy
#' @return rt
#' @author Miss Oriade Latifah Simpson, \email{s172084@@dtu.dk}
#' @export
#' @examples
#' data("wide_wide_west")
#' west_data_wide
#' fitted_pca_object <- perform_pca(west_data_wide)
#' fitted_pca_object
#' rot_tab <- make_rotation_table(fitted_pca_object)
#' rot_tab
make_rotation_table <- function(pca_fit) {
  rt <- pca_fit %>%
    broom::tidy(matrix = "rotation")
  
  return(rt)
}