Merge pull request #11 from katilingban/dev

create add logo function

.github/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+## Bugs
+
+* Submit an issue on the [issues page](https://github.com/katilingban/pakete/issues)
+
+## Code contributions
+
+* Fork this repository to your Github account
+
+* Clone your version on your account down to your machine from your account 
+
+```
+git clone https://github.com/<yourgithubusername>/pakete.git
+```
+
+* Make sure to track progress upstream i.e., on our version of `pakete` 
+at `katilingban/pakete`, by doing 
+
+```
+git remote add upstream https://github.com/katilingban/pakete.git
+```
+
+* Before making changes make sure to pull changes in from `upstream` by doing 
+either `git fetch upstream` then merge later or `git pull upstream` to fetch 
+and merge in one step
+
+* Make your changes on a new feature branch
+
+* Please write a test or tests for your changes if they affect code and not just 
+documentation
+
+* Push up changes to your account
+
+* Submit a pull request at `katilingban/pakete`

DESCRIPTION

@@ -13,8 +13,9 @@ Description: Tools and utilities for package development currently not
    and repetitive tasks easily implementable.
 License: GPL (>= 3)
 Imports: 
-    stringr
+    jsonlite,
+    stringr,
+    withr
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.1
-

NAMESPACE

@@ -2,5 +2,10 @@
 
 export(add_badge_codefactor)
 export(add_badge_status)
+export(add_contributing)
+export(add_logo)
+export(add_zenodo_badge)
+importFrom(jsonlite,fromJSON)
 importFrom(stringr,str_detect)
 importFrom(stringr,str_replace_all)
+importFrom(withr,with_output_sink)

R/add_badge.R

@@ -1,9 +1,11 @@
 #'
-#' Add repostatus badge
+#' Add badges to README
 #'
 #' @param status A character value for status to be assigned to project. This
 #'   can be either *"concept"*, *"wip"*, *"suspended"*, *"abandoned"*,
 #'   *"active"*, *"inactive"*, *"unsupported"*, or *"moved"*.
+#' @param repo Short remote git repository name. If NULL, is determined based
+#'   on current git settings.
 #' @param path Path to file to add repostatus badge to. Set to NULL by default
 #'   which would indicate that a README file in the root directory of the
 #'   project is the target file.
@@ -14,11 +16,13 @@
 #'   Otherwise, a print of the markdown text for the status badge.
 #'
 #' @examples
-#' add_badge_status(
-#'   "wip",
-#'   path = system.file("examples", "README.Rmd", package = "pakete")
-#' )
+#' if (FALSE) {
+#'   add_badge_status("wip")
+#'   add_badge_codefactor(repo = "katilingban/pakete")
+#'   add_badge_zenodo(repo = "katilingban/pakete")
+#' }
 #'
+#' @rdname add_badge
 #' @export
 #'
 
@@ -78,32 +82,15 @@ add_badge_status <- function(status = c("concept", "wip", "suspended",
   )
 
   ## Append replacement text ----
-  writeLines(
-    text = readme_lines,
-    con = "README.Rmd"
-  )
+  writeLines(text = readme_lines, con = path)
 
+  ## Return TRUE if badge was added ----
   TRUE
 }
 
 
 #'
-#' Add CodeFactor badget
-#'
-#' Assumes that repository is already activated in CodeFactor.
-#'
-#' @param repo Short remote git repository name. If NULL, is determined based
-#'   on current git settings.
-#' @param path Path to file to add repostatus badge to. Set to NULL by default
-#'   which would indicate that a README file in the root directory of the
-#'   project is the target file.
-#'
-#' @returns An entry to the badge section of the README of the repository.
-#'   Otherwise, a print of the markdown text for the status badge.
-#'
-#' @examples
-#' if (FALSE) {add_badge_codefactor(repo = "katilingban/pakete")}
-#'
+#' @rdname add_badge
 #' @export
 #'
 
@@ -126,13 +113,7 @@ add_badge_codefactor <- function(repo = NULL,
   }
 
   ## Create badge_text ----
-  badge_text <- paste0(
-    "[![CodeFactor](",
-    badge,
-    ")](",
-    link,
-    ")"
-  )
+  badge_text <- paste0("[![CodeFactor](", badge, ")](", link, ")")
 
   ## Read file in path ----
   readme_lines <- readLines(path, encoding = "UTF-8")
@@ -159,10 +140,70 @@ add_badge_codefactor <- function(repo = NULL,
   )
 
   ## Append replacement text ----
-  writeLines(
-    text = readme_lines,
-    con = "README.Rmd"
+  writeLines(text = readme_lines, con = path)
+
+  ## Return TRUE if badge was added ----
+  TRUE
+}
+
+#'
+#' @rdname add_badge
+#' @export
+#'
+
+add_zenodo_badge <- function(repo = NULL,
+                             path = NULL) {
+  ## Determine repo ----
+  if (is.null(repo))
+    stop("Remote git repository required. Try again")
+
+  ## Get repository ID ----
+  repo_id <- file.path("https://api.github.com/repos", repo) |>
+    jsonlite::fromJSON() |>
+    (\(x) x$id)()
+
+  ## Set CodeFactor defaults ----
+  badge <- paste0("https://zenodo.org/badge/", repo_id, ".svg")
+  link <- paste0("https://zenodo.org/badge/latestdoi/", repo_id)
+
+  ## Create badge text ----
+  badge_text <- paste0("[![DOI](", badge, ")](", link, ")")
+
+  ## Determine which file to append badge to ----
+  if (is.null(path)) {
+    if (file.exists("README.Rmd"))
+      path <- "README.Rmd"
+    else
+      path <- "README.md"
+  }
+
+  ## Read file in path ----
+  readme_lines <- readLines(path, encoding = "UTF-8")
+
+  if (all(badge_text %in% readme_lines))
+    return(FALSE)
+
+  ## Get start and end line of badges ----
+  badges_start_line <- stringr::str_detect(
+    readme_lines, pattern = "badges: start"
+  ) |>
+    (\(x) seq_len(length(x))[x])()
+
+  badges_end_line <- stringr::str_detect(
+    readme_lines, pattern = "badges: end"
+  ) |>
+    (\(x) seq_len(length(x))[x])()
+
+  ## Create replacement text ----
+  readme_lines <- c(
+    readme_lines[seq_len(badges_end_line - 1)],
+    badge_text,
+    readme_lines[seq(from = badges_end_line, to = length(readme_lines))]
   )
 
+  ## Append replacement text ----
+  writeLines(text = readme_lines, con = path)
+
+  ## Return TRUE if badge was added ----
   TRUE
 }

R/add_contributing.R

@@ -0,0 +1,39 @@
+#'
+#' Add contributing document
+#'
+#' @param repo Short remote git repository name. If NULL, is determined based
+#'   on current git settings.
+#'
+#' @returns A CONTRIBUTING.md file in the `.github` directory
+#'
+#' @examples
+#' if (interactive()) add_contributing("katilingban/pakete")
+#'
+#' @export
+#'
+#'
+
+add_contributing <- function(repo = NULL) {
+  ## Get repo name ----
+  repo_name <- stringr::str_extract(string = repo, pattern = "[^/]*$")
+
+  ## Read template ----
+  contrib_lines <- readLines(
+    con = system.file("templates", "CONTRIBUTING.md", package = "pakete")
+  )
+
+  ## Replace {{repo}} ----
+  contrib_lines <- contrib_lines |>
+    stringr::str_replace_all(pattern = "\\{\\{repo\\}\\}", replacement = repo)
+
+  ## Replace {{repo_name}} ----
+  contrib_lines <- contrib_lines |>
+    stringr::str_replace_all(
+      pattern = "\\{\\{repo_name\\}\\}", replacement = repo_name
+    )
+
+  withr::with_output_sink(
+    new = ".github/CONTRIBUTING.md",
+    code = writeLines(text = contrib_lines, con = ".github/CONTRIBUTING.md")
+  )
+}

R/add_logo.R

@@ -0,0 +1,52 @@
+#'
+#' Add HTML snippet for package hex sticker in README
+#'
+#' @param repo Short remote git repository name. If NULL, is determined based
+#'   on current git settings.
+#'
+#' @returns An entry to the first level header section of the README of the
+#'   repository.
+#'
+#' @examples
+#' if (interactive()) add_logo()
+#'
+#' @export
+#'
+
+add_logo <- function(repo = NULL) {
+  ## Get repo name ----
+  repo_name <- stringr::str_extract(string = repo, pattern = "[^/]*$")
+
+  ## Check if logo is available ----
+  #if (file.exists("man/figures/logo.png"))
+
+  logo_text <- "<img src='man/figures/logo.png' width='200px' align='right' />"
+
+  ## Determine which file to append badge to ----
+  if (file.exists("README.Rmd")) {
+    path <- "README.Rmd"
+  } else {
+    path <- "README.md"
+  }
+
+  ## Read file in path ----
+  readme_lines <- readLines(path, encoding = "UTF-8")
+
+  if (any(stringr::str_detect(string = readme_lines, pattern = logo_text)))
+    return(FALSE)
+
+  ## Get start and end line of badges ----
+  header_line <- stringr::str_detect(
+    readme_lines, pattern = paste0("# ", repo_name, ":")
+  ) |>
+    (\(x) seq_len(length(x))[x])()
+
+  ## Create replacement text ----
+  readme_lines[header_line] <- paste0(readme_lines[header_line], " ", logo_text)
+
+  ## Append replacement text ----
+  writeLines(text = readme_lines, con = path)
+
+  ## Return TRUE if badge was added ----
+  TRUE
+}

R/pakete-package.R

@@ -8,5 +8,7 @@
 #' @keywords internal
 #' @name pakete
 #' @importFrom stringr str_detect str_replace_all
+#' @importFrom jsonlite fromJSON
+#' @importFrom withr with_output_sink
 #'
 "_PACKAGE"

README.Rmd

@@ -13,13 +13,14 @@ knitr::opts_chunk$set(
 )
 ```
 
-# pakete: Utilities for Package Development
+# pakete: Utilities for Package Development <img src='man/figures/logo.png' width='200px' align='right' />
 
 <!-- badges: start -->
 [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![R-CMD-check](https://github.com/katilingban/pakete/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/pakete/actions/workflows/R-CMD-check.yaml)
 [![CodeFactor](https://www.codefactor.io/repository/github/katilingban/pakete/badge)](https://www.codefactor.io/repository/github/katilingban/pakete)
+[![DOI](https://zenodo.org/badge/790010725.svg)](https://zenodo.org/badge/latestdoi/790010725)
 <!-- badges: end -->
 
 Tools and utilities for package development currently not available from usual development tools. These are mostly linked to personal preferences during the development process. They assist in making routine and repetitive tasks easily implementable.

README.md

@@ -1,7 +1,7 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# pakete: Utilities for Package Development
+# pakete: Utilities for Package Development <img src='man/figures/logo.png' width='200px' align='right' />
 
 <!-- badges: start -->
 
@@ -12,6 +12,7 @@ public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostat
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![R-CMD-check](https://github.com/katilingban/pakete/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/pakete/actions/workflows/R-CMD-check.yaml)
 [![CodeFactor](https://www.codefactor.io/repository/github/katilingban/pakete/badge)](https://www.codefactor.io/repository/github/katilingban/pakete)
+[![DOI](https://zenodo.org/badge/790010725.svg)](https://zenodo.org/badge/latestdoi/790010725)
 <!-- badges: end -->
 
 Tools and utilities for package development currently not available from

inst/templates/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+## Bugs
+
+* Submit an issue on the [issues page](https://github.com/{{repo}}/issues)
+
+## Code contributions
+
+* Fork this repository to your Github account
+
+* Clone your version on your account down to your machine from your account 
+
+```
+git clone https://github.com/<yourgithubusername>/{{repo_name}}.git
+```
+
+* Make sure to track progress upstream i.e., on our version of `{{repo_name}}` 
+at `{{repo}}`, by doing 
+
+```
+git remote add upstream https://github.com/{{repo}}.git
+```
+
+* Before making changes make sure to pull changes in from `upstream` by doing 
+either `git fetch upstream` then merge later or `git pull upstream` to fetch 
+and merge in one step
+
+* Make your changes on a new feature branch
+
+* Please write a test or tests for your changes if they affect code and not just 
+documentation
+
+* Push up changes to your account
+
+* Submit a pull request at `{{repo}}`