Package 'urlchecker'

Title: Run CRAN URL Checks from Older R Versions
Description: Provide the URL checking tools available in R 4.1+ as a package for earlier versions of R. Also uses concurrent requests so can be much faster than the serial versions.
Authors: R Core team [aut] (The code in urltools.R adapted from the tools package), Jim Hester [aut] , Gábor Csárdi [aut, cre], Posit Software, PBC [cph, fnd]
Maintainer: Gábor Csárdi <[email protected]>
License: GPL-3
Version: 1.0.1.9000
Built: 2024-06-18 05:32:48 UTC
Source: https://github.com/r-lib/urlchecker

Help Index


Check urls in a package

Description

Runs the url_db_from_package_source function in the tools package along with a function to check URLs in un-rendered Rmarkdown vignettes.

Usage

url_check(
  path = ".",
  db = NULL,
  parallel = TRUE,
  pool = curl::new_pool(),
  progress = TRUE
)

Arguments

path

Path to the package

db

A url database

parallel

If TRUE, check the URLs in parallel

pool

A multi handle created by curl::new_pool(). If NULL use a global pool.

progress

Whether to show the progress bar for parallel checks

Value

A url_checker_db object (invisibly). This is a check_url_db object with an added class with a custom print method.

Examples

## Not run: 
url_check("my_pkg")

## End(Not run)

Update URLs in a package

Description

First uses url_check to check and then updates any URLs which are permanent (301) redirects.

Usage

url_update(path = ".", results = url_check(path))

Arguments

path

Path to the package

results

results from url_check.

Value

The results from url_check(path), invisibly.

Examples

## Not run: 
url_update("my_pkg")

## End(Not run)