Initialize report using functions

DESCRIPTION

@@ -19,8 +19,12 @@ RoxygenNote: 7.2.3
 URL: https://esqlabs.github.io/esqlabsR.reports/
 Imports: 
     fs (>= 1.6.3),
-    glue (>= 1.6.2)
+    glue (>= 1.6.2),
+    rstudioapi (>= 0.14),
+    yaml (>= 2.3.7)
 Remotes:  
     tidyverse/glue,
     r-lib/withr,
-    r-lib/fs
+    r-lib/fs,
+    vubiostat/r-yaml,
+    rstudio/rstudioapi

NAMESPACE

@@ -1,3 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
-export(new_report)
+export(getYamlStartEnd)
+export(newReport)
+export(replaceYaml)

R/new-report.R

@@ -0,0 +1,44 @@
+#' Create a new report
+#'
+#' @param file_name a string that represent the name of the report that will be created.
+#' @param path a string that represent the path where to create the report.
+#' @param template one string (either `report` or `tutorial`) representing the type of template to initialize.
+#' @param subtitle the subtitle of the report. empty by default.
+#' @param author the name of the author(s). "esqlabs Gmbh" by default.
+#' @param datetime the date time that will appear on the report in "YYYY-MM-DD HH:MM:SS" format. default to time of generation of the report.
+#'
+#' @export
+#'
+#' @examples
+#' newReport("my_report", "report_folder/")
+newReport <- function(report_title, path = "Reports/", template = "report", subtitle = NA, author = NA, datetime = NA) {
+
+
+  template_dir <- system.file(paste0("templates/", template), package = "esqlabsR.reports")
+  target_dir <- file.path(path, report_title)
+  project_filename <- glue::glue("{report_title}.Rproj")
+  project_fullpath <- file.path(target_dir, project_filename)
+  report_filename <-  glue::glue("{report_title}.qmd")
+  report_fullpath <- file.path(target_dir, report_filename)
+
+  fs::dir_copy(path = template_dir, new_path = target_dir)
+
+  file.rename(file.path(target_dir, "template.Rproj"),
+              project_fullpath)
+
+  file.rename(file.path(target_dir, "template.qmd"),
+              report_fullpath)
+
+  args <- list(title = report_title,
+               subtitle = subtitle,
+               author = author,
+               date = datetime)
+
+  editYaml(report_fullpath, args)
+
+  if(interactive()){
+    rstudioapi::openProject(project_fullpath)
+  }
+
+}
+

R/yaml-handler.R

@@ -0,0 +1,85 @@
+editYaml <- function(file_path, args) {
+
+  original_yaml <- extractYaml(text = readLines(file_path))
+
+  new_yaml <- original_yaml
+
+  for (arg in names(args)) {
+    if(!is.na(args[[arg]])){
+      new_yaml[[arg]] <- args[[arg]]
+    }
+  }
+
+  replaceYaml(file_path = file_path,
+              new_yaml =  new_yaml)
+
+}
+
+
+#' Get YAML header from a text vector
+#'
+#' @param text a vector of string the text read from a file
+#'
+#' @return a list representing the yaml that can be exported back to yaml format
+#'
+#' @examples
+extractYaml <- function(text) {
+
+  yaml_lines_index <- getYamlStartEnd(text = text)
+
+  yaml <- yaml::read_yaml(text = text[yaml_lines_index[1]:yaml_lines_index[2]])
+
+  return(yaml)
+
+}
+
+
+#' Replace yaml header of a file
+#'
+#' @param file_path a string representing the file containing the yaml header to replace.
+#' @param new_yaml a list representing the yaml header to inject
+#' @export
+#'
+#' @examples
+replaceYaml <- function(file_path, new_yaml) {
+
+  text <- readLines(file_path)
+
+  yaml_start_end <- getYamlStartEnd(text = text, only_content = FALSE)
+
+  text_without_yaml <- text[-c(yaml_start_end[1]:yaml_start_end[2])]
+
+  text_with_new_yaml <- c("---",
+                          yaml::as.yaml(new_yaml),
+                          "---",
+                          text_without_yaml)
+
+  writeLines(text_with_new_yaml, file_path)
+
+}
+
+#' Identify where the yaml header starts and end in a file
+#'
+#' @param text a string vector containing the read lines of a file
+#' @param only_content a logical defining if the returned index should be for
+#' the yaml delimiters or the yaml content.
+#'
+#' @return a numeric vector of size two representing the index
+#' @export
+#'
+#' @examples
+getYamlStartEnd <- function(text, only_content = TRUE) {
+  yaml_delimiters_index <- which(text == "---")
+
+  if (only_content) {
+    index_correction = 1
+  } else {
+    index_correction = 0
+  }
+
+  yaml_lines_start_index <- yaml_delimiters_index[1]+index_correction
+  yaml_lines_end_index <- yaml_delimiters_index[2]-index_correction
+
+  return(c(yaml_lines_start_index, yaml_lines_end_index))
+
+}

inst/templates/report/.gitignore

@@ -0,0 +1 @@
+/.quarto/