R/use_index_md.R

In KWB-R/kwb.pkgbuild: R package for standardised development at KWB

# use_index_md ----------------------------------------------------------------

#' Use index.md (used for pkgdown::build_home())
#' @param user user name or organisation under which repository defined in\cr
#' parameter "repo" is hosted (default: "KWB-R")\cr
#' @param domain under which repository is hosted (default: "github")
#' @param stage badge declares the developmental stage of a package, according
#' to [https://www.tidyverse.org/lifecycle/](https://www.tidyverse.org/lifecycle/),
#' valid arguments are: "experimental", "maturing", "stable", "retired",
#' "archived", "dormant", "questioning"), (default: "experiment")
#' @return generates travis badge link
#' @export
#' @importFrom desc desc

use_index_md <- function(
  user = "KWB-R", domain = "github", stage = "experimental"
)
{
  pkg <- read_description()

  index_md <- c(
    use_badge_ghactions(pkg$name, user),
    use_badge_codecov(pkg$name, user, domain ),
    use_badge_lifecycle(stage),
    use_badge_cran(pkg$name),
    use_badge_runiverse(pkg$name),
    "",
    pkg$desc,
    "",
    use_installation(pkg$name, user, domain)
  )

  writeLines(index_md, "index.md")

  write_to_rbuildignore(ignore_pattern = "^index\\.md$")

  index_md
}