dev_history.Rmd for working package"

In lightparser: From 'Rmarkdown' and 'Quarto' Files to Tibble and Back

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")

Read data

# Set error=TRUE for checks() if needed
# Run all in the console directly
# Create "inst/" directory
dir.create(here::here("inst"))
# Example dataset
file.copy(system.file("nyc_squirrels_sample.csv", package = "fusen"), here::here("inst"))

Calculate the median of a vector

Here is some inline R code : r 1+1

#' 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_error(my_median("text"))
})

Calculate the mean of a vector

Use sub-functions in the same chunk

#| filename: the_median_file

#' 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
sub_median <- function(x, na.rm = TRUE) {
    stats::median(x, na.rm)
}

my_other_median(1:12)
my_other_median(8:20)
my_other_median(20:50)

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"))
})

not a R chunk that should be kept in vignette, but not in code

#| eval: no
# 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

lightparser documentation built on May 29, 2024, 4:39 a.m.