Add changelog md file function

R/init_changelog_md.R

@@ -0,0 +1,61 @@
+#' A changelog markdown template to document project progress
+#'
+#' @param path Path where markdown file is created
+#' @param confirm Confirm path; logical input.
+#'
+#' @return Return markdown file in specified or current working directory
+#' @export
+#'
+#' @examples
+#' init_changelog_md()
+init_changelog_md <- function(path = getwd(), confirm = TRUE){
+
+
+  # Display a message before the prompt
+  cat("You current working directory will be:\n")
+  cat(path)
+
+  if(confirm){
+    user_input <- tolower(
+      readline(
+        prompt = "Do you wish to create a Change log MD here? (y/yes to confirm): "
+      )
+    )
+  }else{
+    user_input <- "y"
+  }
+
+
+  # Check if the user input is 'y' or 'yes'
+  if (user_input %in% c("y", "yes")) {
+    wd_path <- path
+
+    markdown_content <- "
+# CHANGELOG
+
+``` txt
+YYYY-MM-DD  John Doe
+
+* Big Change 1
+* Another Change 2
+```
+    "
+    aa <- file.path(wd_path,"CHANGELOG.md")
+    file.create(aa, showWarnings = FALSE)
+
+    if(file.exists(aa)){
+      fileConn <- file(aa)
+
+      writeLines(
+        markdown_content,
+        fileConn
+      )
+      close(fileConn)
+
+    }
+
+  } else {
+    cat("Change log MD initialization canceled.\n")
+  }
+
+}

inst/markdown/templates/changelog_md_template/skeleton/skeleton.md

@@ -0,0 +1,8 @@
+# CHANGELOG
+
+``` txt
+YYYY-MM-DD  John Doe
+
+* Big Change 1
+* Another Change 2
+```

inst/markdown/templates/changelog_md_template/template.yaml

@@ -0,0 +1,3 @@
+name: "CHANGELOG MD"
+description: "A template to document project progress"
+create_dir: false

inst/rmarkdown/templates/changelog_template/skeleton/skeleton.Rmd

@@ -11,10 +11,7 @@ print(paste0("Last updated: ",Sys.time()))
 
 ------------------------------------------------------------------------
 
-# Project Introduction
-
-Write some project description
-
+# CHANGELOG
 ------------------------------------------------------------------------
 
 YYYY-MM-DD John Doe