Package 'fakin.path.app'

path to the directory from which to start searching for files

path to the output directory. In this directory, a file "path-info_<date-time>_<parent-folder>.csv" will be generated with <date-time> being a date and time string in yyyy-mm-dd_HHMM format and <parent-folder> being the last path segment of root_dir

if TRUE (default) it is checked in advance if both root_dir and output_dir exist. Switch this off if e.g. network paths are wrongly considered to be non-existing.

format string specifying how to format the part of the filename intended to contain date (and, if required, time) information. Default: "%Y-%m-%d_%H%M"

further arguments passed to get_recursive_file_info and finally to fs::dir_info. Set e.g. fail = FALSE to avoid failure due to insufficient access permissions.

path to the root directory from which to start the recursive search for files

regular expression matching the names of the files to be considered. By default, all files are considered.

if TRUE (default) hidden files are also returned

further arguments passed to fs::dir_info

if TRUE (default) progress messages are shown

path to text file

number of first rows of file from which to guess the meta information.

further arguments passed to fakin.path.app:::read_lines, such as fileEncoding

String of which the left part is compared with y

String to be compared with the left part of x

vector of character

level of mildness. 1: not mild, all characters must be hyphen or alphanumeric or dot or underscore, 2: more mild, all characters must be one of the above or space

character of (file or folder) names, e.g. as they appear as node labels in the plot generated with plot_path_network

list of data frames each of which contains file path information as returned by read_file_info

if TRUE the plots are saved to png-files in tempdir(). The name is then taken from the names of the elements in path_infos. Otherwise the plot go into the current graphical device.

further arguments passed to plot_treemaps_from_path_data, such as n_levels

character vector of paths

maximum depth of paths to be shown

passed to sankeyNetwork, see there. Decrease this value (e.g. 'nodePadding = 0') if there are many nodes to plot and the plot does not look as expected

height of a node in pixels. Used to calculate the total plot height.

passed to sankeyNetwork, see there

remove the common root parts? (default: TRUE)

if not NULL expected to be a function that accepts a vector of (node) names and returns a vector of (colour) names of same length. This function will be called by plot_path_network to determine the colour for each node based on its name. By default, the function name_to_traffic_light is called.

plot height in pixels, passed to sankeyNetwork. If NULL, the height is calculated based on nodeHeight, nodePadding and the maximum number of nodes at one folder depth.

further arguments passed to sankeyNetwork, such as nodeWidth, nodePadding, fontSize

if 1 (default) the function behaves as before, another value activates the new preparation of paths accepting/using an object of class pathlist

one of "n_files", "size", "none". Specifies whether to set the link widths according to the total number or total size of files in subsequent folders or by setting all links to the same width.

file sizes corresponding to the paths

data frame containing file path information as returned by read_file_info

path to the folder that contains all paths to be considered. By setting the root path to "/path/to/root" you can "zoom into" the treeplot, showing the contents below "/path/to/root" only. If root_path is "" (default) all paths in path_data are considered.

name to be used in png file name if as_png is set. If path_data is a list, the names of the list elements are used.

if TRUE (default) the plots are saved to png files in the directory given in output_dir (tempdir() by default). Otherwise they are plotted into the active graphical device.

number of folder depth levels to be shown in the plots

path to output directory if as_png = TRUE. Default: tempdir()

passed to treemap

list of arguments passed to png if as_png = TRUE

vector of integer, specifying the number(s) of biggest folders (in terms of size and number of files) in which to "zoom into". The position in the vector represents the folder depth. For example, if n_biggest = c(2, 1), the first element (2) indicates that sub-treemaps are produced for the two biggest subfolders below root_path: for root_path/biggest-1 and for root_path/biggest-2. The second element (1) indicates that further treemaps are generated only for the biggest subfolders below root_path/biggest-1 and root_path/biggest-2, respectively, in each case. The length of the vector n_biggest determines the maximal depth until which to generate treemaps. By setting an element to -1L you specify that sub-treemaps are generated for each subfolder on the corresponding folder depth.

current depth of recursion

type(s) of treeplots: one or both of c("size", "files") (the default).

data frame as returned by read_file_info

path to the folder that contains all paths to be considered. By setting the root path to "/path/to/root" you can "zoom into" the treeplot, showing the contents below "/path/to/root" only. If root_path is "" (default) all paths in path_data are considered.

name(s) of variable(s) to be selected. Default: "size"

further arguments passed to remove_common_root, such as n_keep (number of last segments to be kept from the common first part of all paths)

file containing file path information (path only or additional information such as file type, size or creation/modification time, etc.)

data frame containing metadata about the file. If given, it must look as what guess_file_metadata returns. If NULL the same function is called to guess metadata about the file.

a connection object or character string

arguments passed to readLines

passed to readLines.

The name of the encoding to be assumed. Passed as encoding to file, see there.

if not NULL the path to a folder containing text files with path information. Default: fakin.path.app:::default_targetdir()

further key = value pairs to be used as global variables

data frame

path to CSV file to be written

column separator

determines which function to use for writing the CSV file 1: write.table, 2: fwrite

further arguments passed to write.table or fwrite

data frame as returned by get_recursive_file_info

path to CSV file to be written

determines which function to use for writing the CSV file 1: write.table, 2: fwrite