vsi_read_dir {gdalraster} | R Documentation |
Read names in a directory
Description
vsi_read_dir()
abstracts access to directory contents. It returns a
character vector containing the names of files and directories in this
directory. This function is a wrapper for VSIReadDirEx()
in the GDAL
Common Portability Library.
Usage
vsi_read_dir(path, max_files = 0L)
Arguments
path |
Character string. The relative or absolute path of a directory to read. |
max_files |
Integer scalar. The maximum number of files after which to stop, or 0 for no limit (see Note). |
Value
A character vector containing the names of files and directories
in the directory given by path
. An empty string (""
) is returned if
path
does not exist.
Note
If max_files
is set to a positive number, directory listing will stop
after that limit has been reached. Note that to indicate truncation, at
least one element more than the max_files
limit will be returned. If the
length of the returned character vector is lesser or equal to max_files
,
then no truncation occurred.
See Also
vsi_mkdir()
, vsi_rmdir()
, vsi_stat()
, vsi_sync()
Examples
# regular file system for illustration
data_dir <- system.file("extdata", package="gdalraster")
vsi_read_dir(data_dir)