check_urls: Check urls in dynamic report files

In sketchy: Create Custom Research Compendiums

Check urls in dynamic report files

Description

check_urls Check urls in dynamic report files (.md, .Rmd & .qmd)

Usage

check_urls(path = ".")

Arguments

path	Path to the directory containing the files to be checked. Default is current directory.

Details

The function can be used to check if url addresses in dynamic reports are broken. Taken from Nan Xiao's blogpost (https://nanx.me/blog/post/rmarkdown-quarto-link-checker/).

Value

A url_checker_db object with an added class with a custom print method.

Author(s)

Nan Xiao ([e-mail])

References

Araya-Salas, M., Arriaga, A. (2023), sketchy: research compendiums for data analysis in R. R package version 1.0.3. Xiao, N. (2023). A General-Purpose Link Checker for R Markdown and Quarto Projects. Blog post. https://nanx.me/blog/post/rmarkdown-quarto-link-checker/

See Also

add_to_gitignore, make_compendium

Examples

{
data(compendiums)

# make compendiums
make_compendium(name = "my_compendium", path = tempdir(),
format = "basic", force = TRUE)

# check urls in scripts
check_urls(path = file.path(tempdir(), "./scripts"))
}

sketchy documentation built on April 4, 2025, 5:39 a.m.