From d08f401fb16d716f2747857c119ac38af4823562 Mon Sep 17 00:00:00 2001 From: Ghislain Durif <gd.dev@libertymail.net> Date: Mon, 6 Mar 2023 10:36:21 +0100 Subject: [PATCH] minor modifications --- R_pkg_dev_helper.qmd | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/R_pkg_dev_helper.qmd b/R_pkg_dev_helper.qmd index f283250..b00b6e3 100644 --- a/R_pkg_dev_helper.qmd +++ b/R_pkg_dev_helper.qmd @@ -38,7 +38,7 @@ my_package ## [`devtools`](https://devtools.r-lib.org/) -### Tools to Make Developing R Packages Easier • devtools +### Tools to Make Developing R Packages Easier ```{r, eval=FALSE} # load local package without installing it @@ -55,7 +55,7 @@ devtools::build() devtools::check() ``` -#### Additional linls +#### Additional links - [Package dev cheatsheet](https://devtools.r-lib.org/#cheatsheet) @@ -185,7 +185,7 @@ fusen::add_flat_template(path, flat_name = "package") ## [`roxygen2`](https://roxygen2.r-lib.org/) -### In-Line Documentation for R • roxygen2 +### In-Line Documentation for R File `R/add.R`: @@ -203,7 +203,7 @@ add <- function(x, y) { } ``` -Automatic generation of `man/add.Rd` with `devtools::document()` +Automatic generation of `man/add.Rd` with `devtools::document()`: ```Rd % Generated by roxygen2: do not edit by hand % Please edit documentation in ./<text> @@ -255,11 +255,10 @@ test_that("multiplication works", { }) ``` -Automatically run during package check (e.g. with `devtools::check()`) or specifically with `devtools::check()`. +Automatically run during package check (e.g. with `devtools::check()`) or specifically with `devtools::test()`. ## [`checkmate`](https://mllg.github.io/checkmate/) - ### Fast and versatile argument checks for R - `assert_xxx()` fails if assertion not met -- GitLab