You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
boB Rudis 7f93de696f
native
2 years ago
R native 2 years ago
inst native 2 years ago
man native 2 years ago
tests R package repo initialization complete 2 years ago
.Rbuildignore pkg done 2 years ago
.codecov.yml R package repo initialization complete 2 years ago
.gitignore R package repo initialization complete 2 years ago
.travis.yml R package repo initialization complete 2 years ago
CONDUCT.md R package repo initialization complete 2 years ago
DESCRIPTION native 2 years ago
LICENSE pkg done 2 years ago
LICENSE.md pkg done 2 years ago
NAMESPACE native 2 years ago
NEWS.md Fixes #1 2 years ago
README.Rmd native 2 years ago
README.md native 2 years ago
slugify.Rproj R package repo initialization complete 2 years ago

README.md

Project Status: Active – The project has reached a stable, usablestate and is being activelydeveloped. Signedby Signed commit% Linux buildStatus
Minimal RVersion License

slugify

Create slug strings for SEO

Description

Most blogging platforms turn title phrases into slugs for better SEO. Tools are provided to turn phrases into slugs.

What’s Inside The Tin

The following functions are implemented:

  • slugify_fast: Much faster string slugifier

  • slugify_native: Native R slugify (with the help of stringi)

  • slugify: Slugify a string

Installation

install.packages("slugify", repos = c("https://cinc.rud.is", "https://cloud.r-project.org/"))
# or
remotes::install_git("https://git.rud.is/hrbrmstr/slugify.git")
# or
remotes::install_git("https://git.sr.ht/~hrbrmstr/slugify")
# or
remotes::install_gitlab("hrbrmstr/slugify")
# or
remotes::install_bitbucket("hrbrmstr/slugify")
# or
remotes::install_github("hrbrmstr/slugify")

NOTE: To use the ‘remotes’ install options you will need to have the {remotes} package installed.

Usage

library(slugify)

# current version
packageVersion("slugify")
## [1] '0.2.0'
slugify("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET")
## [1] "new-package-cdccovidview-to-work-with-the-us-cdcs-new-covid-19-trackers-covidview-and-covid-net"

slugify("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET", replacement = "@")
## [1] "new@package@cdccovidview@to@work@with@the@us@cdcs@new@covid19@trackers@covidview@and@covidnet"

slugify("R is great!", remove = "/[Rr]/g")
## [1] "is-geat"
slugify_native("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET")
## [1] "new-package-cdccovidview-to-work-with-the-us-cdcs-new-covid-19-trackers-covidview-and-covid-net"

slugify_native("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET", repl = "@")
## [1] "new@package@cdccovidview@to@work@with@the@us@cdcs@new@covid-19@trackers@covidview@and@covid-net"
microbenchmark::microbenchmark(
  slugify_native("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET"),
  slugify("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET"),
  control = list(warmup = 10)
)
## Unit: microseconds
##                                                                                                                         expr
##  slugify_native("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET")
##         slugify("New Package — {cdccovidview} — To Work with the U.S. CDC’s New COVID-19 Trackers: COVIDView and COVID-NET")
##      min      lq     mean   median      uq      max neval
##  402.524 446.394 519.0379 476.3795 561.544  880.638   100
##  499.746 539.201 690.6867 571.3005 760.809 2282.490   100

slugify Metrics

Lang # Files (%) LoC (%) Blank lines (%) # Lines (%)
R 6 0.86 131 0.88 25 0.52 43 0.55
Rmd 1 0.14 18 0.12 23 0.48 35 0.45

clock Package Metrics for slugify

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.