R/filesstrings-package.R

#' @import stringr
#' @importFrom magrittr '%>%' '%<>%' '%T>%'
#' @importFrom strex match_arg
#' @importFrom stringi '%stri$%'
NULL

## quiets concerns of R CMD check re: the .'s that appear in pipelines
if (getRversion() >= "2.15.1") {
  utils::globalVariables(c("."))
}

#' `filesstrings`: handy file and string manipulation
#'
#' This started out as a package for file and string manipulation. Since then,
#' the `fs` file manipulation package and the `strex` string manipulation
#' package emerged, offering functionality previously given by this package (but
#' slightly better). Those packages have hence almost pushed 'filesstrings' into
#' extinction. However, it still has a small number of unique, handy file
#' manipulation functions which can be seen in the `r roxy_files_vignette()`.
#' One example is a function to remove spaces from all file names in a
#' directory.
#'
#' @docType package
#' @name filesstrings
#' @aliases filesstrings-package
#' @references Rory Nolan and Sergi Padilla-Parra (2017). filesstrings: An R
#'   package for file and string manipulation. The Journal of Open Source
#'   Software, 2(14).  \doi{10.21105/joss.00260}.
NULL
rorynolan/filesstrings documentation built on Feb. 5, 2024, 6:01 p.m.