create base vignette

katilingban · Apr 22, 2024 · 9558b15 · 9558b15
1 parent d7b6006
commit 9558b15
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 7 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -6,3 +6,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^codecov\.yml$
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 .RData
 .Ruserdata
 docs
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -17,10 +17,13 @@ Imports:
     stringr,
     withr
 Suggests: 
-    spelling    
+    knitr,
+    rmarkdown,
+    spelling
 Encoding: UTF-8
 Language: en-GB
 LazyData: true
 RoxygenNote: 7.3.1
 Roxygen: list(markdown = TRUE)
-URL: http://katilingban.io/pakete/
+URL: https://katilingban.io/pakete/, https://github.com/katilingban/pakete
+VignetteBuilder: knitr
diff --git a/README.Rmd b/README.Rmd
@@ -19,6 +19,7 @@ knitr::opts_chunk$set(
 [![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)
+[![test-coverage](https://github.com/katilingban/pakete/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/katilingban/pakete/actions/workflows/test-coverage.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 -->
@@ -52,7 +53,7 @@ install.packages(
 
 ### Creating GitHub issues checklist template for CRAN submissions
 
-It is useful for some to have a checklist of tasks to be done as part of the CRAN submission process. The [*Releasing to CRAN* chapter](https://r-pkgs.org/release.html) of second edition of the R packages book provides good templates for tasks to do for an [initial CRAN release](https://r-pkgs.org/release.html#sec-release-initial), an [update CRAN release](https://r-pkgs.org/release.html#keeping-up-with-change), a [submission of package to CRAN](https://r-pkgs.org/release.html#sec-release-process), and a [post-acceptance to CRAN](https://r-pkgs.org/release.html#sec-release-post-acceptance).
+It is useful for some to have a checklist of tasks to be done as part of the CRAN submission process. The [*Releasing to CRAN*](https://r-pkgs.org/release.html) chapter of the second edition of the R packages book provides good templates for tasks to do for an [initial CRAN release](https://r-pkgs.org/release.html#sec-release-initial), an [update CRAN release](https://r-pkgs.org/release.html#keeping-up-with-change), a [submission of package to CRAN](https://r-pkgs.org/release.html#sec-release-process), and a [post-acceptance to CRAN](https://r-pkgs.org/release.html#sec-release-post-acceptance).
 
 The function `add_issue_template()` assists in creating a GitHub issue template for your package repository for each of these stages of preparing for, submitting to, and getting accepted by CRAN. So, if you want to setup an issues checklist that you can use for preparing to submit to CRAN for an initial release, use:
 

diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@ public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostat
 [![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)
+[![test-coverage](https://github.com/katilingban/pakete/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/katilingban/pakete/actions/workflows/test-coverage.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 -->
@@ -50,10 +51,11 @@ install.packages(
 ### Creating GitHub issues checklist template for CRAN submissions
 
 It is useful for some to have a checklist of tasks to be done as part of
-the CRAN submission process. The [*Releasing to CRAN*
-chapter](https://r-pkgs.org/release.html) of second edition of the R
-packages book provides good templates for tasks to do for an [initial
-CRAN release](https://r-pkgs.org/release.html#sec-release-initial), an
+the CRAN submission process. The [*Releasing to
+CRAN*](https://r-pkgs.org/release.html) chapter of the second edition of
+the R packages book provides good templates for tasks to do for an
+[initial CRAN
+release](https://r-pkgs.org/release.html#sec-release-initial), an
 [update CRAN
 release](https://r-pkgs.org/release.html#keeping-up-with-change), a
 [submission of package to

diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,14 @@
+comment: false
+
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+        informational: true
+    patch:
+      default:
+        target: auto
+        threshold: 1%
+        informational: true
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -7,6 +7,8 @@ WIP
 Zenodo
 cran
 github
+ke
 md
 repostatus
+te
 wip
diff --git a/man/pakete.Rd b/man/pakete.Rd
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/pakete.Rmd b/vignettes/pakete.Rmd
@@ -0,0 +1,21 @@
+---
+title: "Why pakete?"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Why pakete?}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup, echo = FALSE}
+library(pakete)
+```
+
+In Filipino, **pakete** (pronounced */pa.ke.te/*) is our word for package. My main motivation for `pakete` is to serve as my personal utility tool for package development. There are amazing packages such as `usethis` and `devtools` that provide functions that facilitate the implementation of the different steps needed in package development. However, there are other small tasks not covered by any of these packages that I find myself performing repetitively in my package development workflow.