R/pystr_lstrip.R

In nicolewhite/pystr: Python String Methods in R

#' Left strip a string.
#'
#' Return a copy of the string with leading characters removed.
#'
#' The \code{chars} argument is a string specifying the set of characters to be removed.
#' If omitted, the \code{chars} argument defaults to removing whitespace.
#' The \code{chars} argument is not a prefix; rather, all combinations of its values are stripped.
#'
#' @param str A character vector.
#' @param chars A character string.
#'
#' @return A character vector.
#'
#' @references \url{https://docs.python.org/3/library/stdtypes.html#str.lstrip}
#'
#' @seealso \code{\link{pystr_rstrip}}
#'
#' @examples
#' pystr_lstrip("     spacious    ")
#' pystr_lstrip("www.example.com", "w.")
#'
#' @export
pystr_lstrip <- function(str, chars=" ") {
  return( pystr_lstrip_(str,chars) )
}