ils {rirods} | R Documentation |
List iRODS Data Objects and Collections
Description
List the contents of a collection, optionally with stat, metadata, and/or access control information for each element in the collection.
Usage
ils(
logical_path = ".",
stat = FALSE,
permissions = FALSE,
metadata = FALSE,
offset = numeric(1),
limit = find_irods_file("max_number_of_rows_per_catalog_query"),
recurse = FALSE,
ticket = NULL,
message = TRUE,
verbose = FALSE
)
Arguments
logical_path |
Path to the collection whose contents are to be listed.
By default this is the current working collection (see |
stat |
Whether stat information should be included. Defaults to |
permissions |
Whether access control information should be included.
Defaults to |
metadata |
Whether metadata information should be included. Defaults to
|
offset |
Number of records to skip for pagination. Deprecated. |
limit |
Number of records to show per page. |
recurse |
Recursively list. Defaults to |
ticket |
A valid iRODS ticket string. Defaults to |
message |
Show message when empty collection. Default to |
verbose |
Whether information should be printed about the HTTP request
and response. Defaults to |
Value
Dataframe with logical paths and, if requested, additional information.
See Also
ipwd()
for finding the working collection,
ipwd()
for setting the working collection, and
list.files()
for an R equivalent.
Examples
is_irods_demo_running()
# connect project to server
create_irods("http://localhost:9001/irods-http-api/0.2.0")
# authenticate
iauth("rods", "rods")
# list home directory
ils()
# make collection
imkdir("some_collection")
# list a different directory
ils("/tempZone/home/rods/some_collection")
# show metadata
ils(metadata = TRUE)
# delete `some_collection`
irm("some_collection", force = TRUE, recursive = TRUE)