R/generate_markdown_for_projects.R

In condensr: Academic Group Website Generator

#' Generate markdown for projects
#'
#' Generate markdown block for `codensr` projects.
#'
#' @param project A `condensr` project object. If a link is available (i.e.
#' `!is.na(project$link)`), then a hyperlink will be inserted.
#' @return No return value, function will output text directly into markdown
#' document using `cat`.
#' 
#' @examples 
#' 
#' example_project <- project(
#'        id = "joes-model",
#'        name = "Joe's Blogging Model",
#'        related_staff = "joe-bloggs"
#'    )
#' generate_markdown_for_projects(example_project)
#'
#' @export
generate_markdown_for_projects <- function(project) {
    if (!"project" %in% class(project)) {
        stop("Input project must have class project")
    }

    if (is.na(project$link)) {
        cat(
            glue::glue("* {project$name}"),
            sep = "\n"
        )
    } else {
        cat(
            glue::glue("* [{project$name}]({project$link})"),
            sep = "\n"
        )
    }

    return (invisible(NULL))
}