R/frontpage.R

Defines functions frontpage_soustitre frontpage_titres frontpage

Documented in frontpage frontpage_soustitre frontpage_titres

#' frontpage
#'
#' Création de la page de présentation du projet.
#'
#' @param type_analyse Informe sur le type d'analyse.
#' @param titre Titre de l'analyse.
#' @param soustitre Facultatif. Sous-titre de l'analyse.
#' @param image Nom de l'image à insérer (inscrire emplacement si nécessaire).
#' @param width Largeur de l'image en cm.
#'
#' @return Code RMD de la page de présentation.
#' @keywords internal
#' @export
frontpage <- function(type_analyse,
                      titre, soustitre = NULL,
                      image = "INESSSlogo.jpg", width = 7){
  catx(
    ltx_insert_image(image, width),
    vspace(1),
    frontpage_titres(chr2ltx(type_analyse), "Large"),
    vspace(4),
    frontpage_titres(chr2ltx(titre), "Huge"),
    frontpage_soustitre(chr2ltx(soustitre), "huge"),

    pagebreak()
  )
}

#' frontpage_titres
#'
#' Inscrit le titre \code{x} centré et de taille \code{size}.
#'
#' @param x Titre.
#' @param size Variable LaTeX indiquant la taille (fontsize).
#'
#' @return Titre centré de taille \code{size}.
#' @keywords internal
#' @export
#' @examples
#' frontpage_titres("Analyse de Variation Systématique", "Large")
#' frontpage_titres("Analyse de Variation Systématique", "normalsize")
#' frontpage_titres("Analyse de Variation Systématique", "Huge")
frontpage_titres <- function(x, size){
  return(paste0(
    "\\begin{center}\\begin{",size,"}\n",x,"\n\\end{",size,"}\\end{center}"
  ))
}

#' frontpage_soustitre
#'
#' Gère le soustitre de la frontpage
#'
#' @return soustitre en LTX sinon NULL.
#' @keywords internal
#' @export
frontpage_soustitre <- function(soustitre, size = "huge"){
  if(!is.null(soustitre)){
    return(paste0(vspace(0.5), frontpage_titres(soustitre, size)))
  } else {
    return(NULL)
  }
}
INESSS-QC/polymed1 documentation built on Aug. 4, 2020, 12:02 a.m.