dev_history.Rmd for working package

In fusen: Build a Package from Rmarkdown Files

library(testthat)

# Describe your package
fusen::fill_description(
  pkg = here::here(),
  fields = list(
    Title = "Build A Package From Rmarkdown File",
    Description = "Use Rmarkdown First method to build your package. Start your package with documentation. Everything can be set from a Rmarkdown file in your project.",
    `Authors@R` = c(
      person("John", "Doe", email = "[e-mail]", role = c("aut", "cre"), comment = c(ORCID = "0000-0000-0000-0000"))
    )
  )
)
# Define License with use_*_license()
usethis::use_mit_license("John Doe")

Calculate the median of a vector

This is the first tools of our wonderful package. You can calculate the median of a numeric vector using function my_median().

• Note that this will first verify that the vector is numeric, otherwise it stops with a meaningful message.

#' My median
#'
#' @param x Vector of Numeric values
#' @inheritParams stats::median
#' @importFrom stats median
#'
#' @return
#' Median of vector x
#' @export
#'
#' @examples
my_median <- function(x, na.rm = TRUE) {
  if (!is.numeric(x)) {stop("x should be numeric")}
  median(x, na.rm = na.rm)
}

my_median(1:12)

test_that("my_median works properly and show error if needed", {
  expect_true(my_median(1:12) == 6.5)
  expect_error(my_median("text"))
})

Calculate again the median of a vector

Use sub-functions in the same chunk

Here is the second wonderful function of our package: my_other_median(). This looks like the first one for sure, but when we teach, it is better to repeat things.

#' My Other median
#'
#' @param x Vector of Numeric values
#' @inheritParams stats::median
#'
#' @return
#' Median of vector x
#' @export
#'
#' @examples
my_other_median <- function(x, na.rm = TRUE) {
  if (!is.numeric(x)) {stop("x should be numeric")}
  sub_median(x, na.rm = na.rm)
}

#' Core of the median not exported
#' @param x Vector of Numeric values
#' @inheritParams stats::median
#' @importFrom stats median
#' @noRd
sub_median <- function(x, na.rm = TRUE) {
  median(x, na.rm)
}

my_other_median(1:12)

test_that("my_median works properly and show error if needed", {
  expect_true(my_other_median(1:12) == 6.5)
  expect_error(my_other_median("text"))
})

That's it ! This the end of the documented story of our package. All components are there.

# Run but keep eval=FALSE to avoid infinite loop
# Execute in the console directly
fusen::inflate(flat_file = "dev/dev_history.Rmd")

fusen documentation built on Aug. 17, 2023, 5:09 p.m.