Skip to contents

Tool: List files

Source: R/tool-files.R
btw_tool_files_list_files.Rd

Tool: List files

Usage

btw_tool_files_list_files(
  path = NULL,
  type = c("any", "file", "directory"),
  regexp = ""
)

Arguments

path

Path to a directory or file for which to get information. The path must be in the current working directory. If path is a directory, we use fs::dir_info() to list information about files and directories in path (use type to pick only one or the other). If path is a file, we show information about that file.

type

File type(s) to return, one of "any" or "file" or "directory".

regexp

A regular expression (e.g. [.]csv$) passed on to grep() to filter paths.

Value

Returns a character table of file information.

See also

Other Tools: btw_tool_docs_package_news(), btw_tool_env_describe_data_frame(), btw_tool_env_describe_environment(), btw_tool_files_read_text_file(), btw_tool_ide_read_current_editor(), btw_tool_package_docs, btw_tool_search_packages(), btw_tool_session_package_info(), btw_tool_session_platform_info(), btw_tools()

Examples

withr::with_tempdir({
  write.csv(mtcars, "mtcars.csv")

  btw_tool_files_list_files(type = "file")
})
#> <btw::BtwToolResult>
#>  @ value  : chr "| path | type | size | modification_time |\n|------|------|------|-------------------|\n| mtcars.csv | file | 1"| __truncated__
#>  @ error  : NULL
#>  @ extra  :List of 1
#>  .. $ data: tibble [1 × 4] (S3: tbl_df/tbl/data.frame)
#>  ..  ..$ path             : 'fs_path' chr "mtcars.csv"
#>  ..  ..$ type             : Factor w/ 8 levels "any","block_device",..: 7
#>  ..  ..$ size             : 'fs_bytes' num 1.74K
#>  ..  ..$ modification_time: POSIXct[1:1], format: "2025-06-03 20:44:16"
#>  @ request: NULL