From 0eae01f7e92df76c0113e4fc25313a85228dd9ee Mon Sep 17 00:00:00 2001 From: Karim-Mane Date: Wed, 24 Jan 2024 18:00:32 +0000 Subject: [PATCH] run devtools::document() --- man/url_check.Rd | 4 ++++ man/url_check_domain_structure.Rd | 15 --------------- 2 files changed, 4 insertions(+), 15 deletions(-) delete mode 100644 man/url_check_domain_structure.Rd diff --git a/man/url_check.Rd b/man/url_check.Rd index 3bd6183a..ced8beeb 100644 --- a/man/url_check.Rd +++ b/man/url_check.Rd @@ -9,6 +9,10 @@ url_check(base_url) \arguments{ \item{base_url}{the URL to the HIS of interest} } +\value{ +throws an error if the domain of the provided URL is not valid, +(invisibly) TRUE +} \description{ Check if the value for the base_url argument has a correct structure } diff --git a/man/url_check_domain_structure.Rd b/man/url_check_domain_structure.Rd deleted file mode 100644 index a380fef7..00000000 --- a/man/url_check_domain_structure.Rd +++ /dev/null @@ -1,15 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/readepi_helpers.R -\name{url_check_domain_structure} -\alias{url_check_domain_structure} -\title{Check whether the domain structure of the URL is correct} -\usage{ -url_check_domain_structure(url_parts) -} -\arguments{ -\item{url_parts}{a character string with the domain from the URL} -} -\description{ -Check whether the domain structure of the URL is correct -} -\keyword{internal}