dev_history.Rmd for working package

In fusen: Build a Package from Rmarkdown Files

library(testthat)

# --> for parse tests
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

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

There can be development actions

These are only included in the present flat template file, their content will not be part of the package anywhere else.

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

Inflate your package

# duplicate empty name

# duplicate empty name

You're one inflate from paper to box. Build your package from this very Rmd using fusen::inflate()

• Verify your "DESCRIPTION" file has been updated
• Verify your function is in "R/" directory
• Verify your test is in "tests/testthat/" directory
• Verify this Rmd appears in "vignettes/" directory

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