R/REigenfaces-package.R

In JohannesKlueh/REigenfaces: Face Recognition using Eigenfaces

#' @details
#' The REigenfaces package contains the following functions:
##' \itemize{
##'  \item{\code{\link{load_pgm_images}}}
##'  \item{\code{\link{load_dataset}}}
##'  \item{\code{\link{show_images}}}
##'  \item{\code{\link{most_important_eigenfaces}}}
##'  \item{\code{\link{similar_faces_indices}}}
##'  \item{\code{\link{reconstructed_dataset_images}}}
##'  \item{\code{\link{runShiny}}}
##' }
#' To learn more about REigenfaces, refer to the vignettes and function documentations.
#' @references
#' Useful links:
#' \itemize{
#'   \item{\url{https://en.wikipedia.org/wiki/Eigenface}: general information}
#'   \item{\url{https://www.bytefish.de/pdf/eigenfaces.pdf}: mathematical details and examples}
#'   \item{\url{https://towardsdatascience.com/eigenfaces-recovering-humans-from-ghosts-17606c328184}: implementation details and training data (\code{lfwcrop_grey.zip})}
#' }
#' @keywords internal
"_PACKAGE"
"_PACKAGE"

# The following block is used by usethis to automatically manage
# roxygen namespace tags. Modify with care!
## usethis namespace: start
## usethis namespace: end
#' @import pixmap shiny stringr
#' @importFrom "graphics" "par"
NULL