File: suffix_refresh.Rd

package info (click to toggle)
r-cran-urltools 1.7.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 512 kB
  • sloc: cpp: 1,234; ansic: 303; sh: 13; makefile: 2
file content (33 lines) | stat: -rw-r--r-- 1,075 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/suffix.R
\name{suffix_refresh}
\alias{suffix_refresh}
\title{Retrieve a public suffix dataset}
\usage{
suffix_refresh()
}
\value{
a dataset equivalent in format to \code{\link{suffix_dataset}}.
}
\description{
\code{urltools} comes with an inbuilt
dataset of public suffixes, \code{\link{suffix_dataset}}.
This is used in \code{\link{suffix_extract}} to identify the top-level domain
within a particular domain name.

While updates to the dataset will be included in each new package release,
there's going to be a gap between changes to the suffixes list and changes to the package.
Accordingly, the package also includes \code{suffix_refresh}, which generates
and returns a \emph{fresh} version of the dataset. This can then be passed through
to \code{\link{suffix_extract}}.
}
\examples{
\dontrun{
new_suffixes <- suffix_refresh()
}

}
\seealso{
\code{\link{suffix_extract}} to extract suffixes from domain names,
or \code{\link{suffix_dataset}} for the inbuilt, default version of the data.
}