diff --git a/.Rbuildignore b/.Rbuildignore index a95dfdc..654c469 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,4 @@ ^_pkgdown\.yml$ ^docs$ ^pkgdown$ +^codecov\.yml$ diff --git a/.gitignore b/.gitignore index 234f028..0d7f03b 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .RData .Ruserdata docs +inst/doc diff --git a/DESCRIPTION b/DESCRIPTION index 97c2fd6..1c39142 100644 --- 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 index 463193a..798557b 100644 --- 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) @@ -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 index 5aad70f..14b4a87 100644 --- 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) @@ -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 new file mode 100644 index 0000000..04c5585 --- /dev/null +++ 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 index 59db697..b85d31b 100644 --- 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 index 17bb603..cd139a2 100644 --- a/man/pakete.Rd +++ b/man/pakete.Rd @@ -12,6 +12,14 @@ tasks easily implementable.} \if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} 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. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://katilingban.io/pakete/} + \item \url{https://github.com/katilingban/pakete} +} + } \author{ \strong{Maintainer}: Ernest Guevarra \email{ernest@guevarra.io} (\href{https://orcid.org/0000-0002-4887-4415}{ORCID}) diff --git a/vignettes/.gitignore b/vignettes/.gitignore new file mode 100644 index 0000000..097b241 --- /dev/null +++ b/vignettes/.gitignore @@ -0,0 +1,2 @@ +*.html +*.R diff --git a/vignettes/pakete.Rmd b/vignettes/pakete.Rmd new file mode 100644 index 0000000..d8d87f4 --- /dev/null +++ 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.