File: traverseDirs.Rd

package info (click to toggle)
r-cran-shinyfiles 0.9.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 1,504 kB
  • sloc: javascript: 2,257; makefile: 5
file content (32 lines) | stat: -rw-r--r-- 1,208 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dirchoose.R
\name{traverseDirs}
\alias{traverseDirs}
\title{Traverse and update a tree representing the file system}
\usage{
traverseDirs(tree, root, restrictions, hidden)
}
\arguments{
\item{tree}{A list representing the tree structure of the file system to
traverse. Each element should at least contain the elements 'name' and
'expanded'. The elements 'empty' and 'children' will be created or updates if
they exist.}

\item{root}{A string with the location of the root folder for the tree}

\item{restrictions}{A vector of directories within the root that should be
filtered out of the results}

\item{hidden}{A logical value specifying whether hidden folders should be
returned or not}
}
\value{
A list of the same format as 'tree', but with updated values to
reflect the current file system state.
}
\description{
This function takes a tree representing a part of the file system and updates
it to reflect the current state of the file system as well as the settings
for each node. Children (contained folders) are recursed into if the parents
expanded element is set to TRUE, no matter if children are currently present.
}