filesstrings v2.0.1

0

Monthly downloads

0th

Percentile

Handy File and String Manipulation

Convenient functions for moving files, deleting directories, and a variety of string operations that facilitate manipulating files and extracting information from strings.

Readme

filesstrings

Convenient functions for moving files, deleting directories, and a variety of string operations that facilitate manipulating file names and extracting information from strings.

Travis-CI Build Status AppVeyor Build Status codecov CRAN\_Status\_Badge RStudio CRAN downloads RStudio CRAN monthly downloads Rdocumentation Project Status: Active – The project has reached a stable, usable state and is being actively developed. JOSS publication DOI

Installation

To install the release version (recommended) from CRAN, in R, enter

install.packages("filesstrings")

To install the development version, in R, first install devtools via install.packages("devtools"). Then enter

devtools::install_github("rorynolan/filesstrings")

Use

First let's load the library:

library(filesstrings)
#> Loading required package: stringr

Files

Move files around

I find it bizarre that base R has no file.move. To move a file, you have to unintuitively rename it. filesstrings provides file.move(files, destinations). This function has the nice feature that if you try to move files to a directory that doesn't exist, it creates the directory first and then puts the files inside. Let's create a directory and a file:

dir.create("tmp_dir")
file.create("tmp.txt")
#> [1] TRUE

Now let's put the file into the directory:

file.move("tmp.txt", "tmp_dir")
#> 1 file moved. 0 failed.

Delete Directories

To delete directories with base R, one has to use unlink(..., recursive = TRUE). The filesstrings package gives you dir.remove() which does the same job.

dir.remove("tmp_dir")
#> 1 directory deleted. 0 failed to delete.

Remove spaces from file names

"A space in your file name is a hole in your soul." - Jenny Bryan

remove_filename_spaces(replacement = "_") replaces them all with underscores for all files in a directory. By default, they are replaced with nothing.

file.create(c("file 1.txt", "file 2.txt"))
#> [1] TRUE TRUE
remove_filename_spaces(pattern = "txt$", replacement = "_")
#> 2 files renamed. 0 failed to rename.
list.files(pattern = "txt$")
#> [1] "file_1.txt" "file_2.txt"
file.remove(list.files(pattern = "txt$"))  # clean up
#> [1] TRUE TRUE

Strings

The nth number in a string

I often want to get the first, last or nth number in a string.

pop <- "A population of 1000 comprised of 488 dogs and 512 cats."
nth_number(pop, 1)
#> [1] 1000
nth_number(pop, -1)  # last number
#> [1] 512

All the numbers in a string

extract_numbers(pop)
#> [[1]]
#> [1] 1000  488  512

All the non-numbers in a string

extract_non_numerics(pop)
#> [[1]]
#> [1] "A population of " " comprised of "   " dogs and "      
#> [4] " cats."

Trim anything (not just whitespace)

stringr's str_trim just trims whitespace. What if you want to trim something else? Now you can trim_anything().

trim_anything("__rmarkdown_", "_")
#> [1] "rmarkdown"

Contribution

Contributions to this package are welcome. The preferred method of contribution is through a github pull request. Feel free to contact me by creating an issue. 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.

Functions in filesstrings

Name Description
filesstrings filesstrings: handy file and string manipulation
locate_braces Locate the braces in a string.
all_equal A more flexible version of all.equal for vectors.
before_last_dot Get the part of a string before the last period.
move_files Move files around.
extend_char_vec Pad a character vector with empty strings.
put_in_pos Put specified strings in specified positions in an otherwise empty character vector.
extract_numbers Extract numbers (or non-numbers) from a string.
can_be_numeric Check if a string could be considered as numeric.
remove_dir Remove directories
count_matches Count the number of the matches of a pattern in a string.
remove_filename_spaces Remove spaces in file names
create_dir Create directories if they don't already exist
remove_quoted Remove the quoted parts of a string.
currency Get the currencies of numbers within a string.
str_split_by_nums Split a string by its numeric characters.
str_after_nth Text before or after \(n\)th occurrence of pattern.
str_elem Extract a single character from a string, using its index.
str_split_camel_case Split a string based on CamelCase
nice_file_nums Make file numbers comply with alphabetical order
str_to_vec Convert a string to a vector of characters
nice_nums Make string numbers comply with alphabetical order
rename_with_nums Replace file names with numbers
str_with_patterns Which strings match the patterns?
singleize Remove back-to-back duplicates of a pattern in a string.
trim_anything Trim something other than whitespace
give_ext Ensure a file name has the intended extension.
unitize_dirs Put files with the same unit measurements into directories
group_close Group together close adjacent elements of a vector.
str_nth_instance_indices Get the indices of the \(n\)th instance of a pattern.
str_paste_elems Extract bits of a string and paste them together
filesstrings-defunct Defunct functions
No Results!

Vignettes of filesstrings

Name
files.Rmd
strings.Rmd
No Results!

Last month downloads

Details

Type Package
License GPL-3
Encoding UTF-8
LazyData true
RoxygenNote 6.0.1
LinkingTo Rcpp
URL https://www.github.com/rorynolan/filesstrings
BugReports https://www.github.com/rorynolan/filesstrings/issues
VignetteBuilder knitr
NeedsCompilation yes
Packaged 2017-12-12 13:49:17 UTC; rnolan
Repository CRAN
Date/Publication 2017-12-12 14:54:38 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/filesstrings)](http://www.rdocumentation.org/packages/filesstrings)