camr_sanitize_path: Sanitize a filename by removing directory paths and invalid...

In rettopnivek/camrprojects: Portable Functions for R Projects at CAM-MGH

Sanitize a filename by removing directory paths and invalid characters.

Description

This function is taken directly from fs::path_sanitize to avoid dependency.

Usage

camr_sanitize_path(chr_filename, chr_replacement = "")

Arguments

chr_filename	A character vector to be sanitized.
chr_replacement	A character vector used to replace invalid characters.

Details

path_sanitize() removes the following:

• Control characters

• Reserved characters

• Unix reserved filenames (. and ..)

• Trailing periods and spaces (invalid on Windows)

• Windows reserved filenames (CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9) The resulting string is then truncated to 255 bytes in length

Value

Character vector containing the sanitized path.

See Also

https://www.npmjs.com/package/sanitize-filename, upon which this function is based.

Examples

# potentially unsafe string
str <- "~/.\u0001ssh/authorized_keys"
path_sanitize(str)

path_sanitize("..")

rettopnivek/camrprojects documentation built on March 26, 2024, 9:17 a.m.