gcs_dir {GCSConnection} | R Documentation

## List bucket/folder/object

### Description

list objects in a bucket/folder or get the description of a file. You can change the current direction via '[[' or '$' operator. '..' can be used to go to the parent folder. For reducing the number of request sent to the network, it is recommended to add a trailing slash if the path is a folder.

### Usage

    gcs_dir(path, delimiter = TRUE, recursive = FALSE, depth = 2L)

### Arguments

`path` | Character(1), the path to the bucket/folder/file.
`delimiter` | Logical(1), whether to use '/' as a path delimiter. If not, the path will be treated as the path to a file even when it ends with '/'
`recursive` | Logical(1), whether recursively query all subdirectory. If 'TRUE', all information of the subdirectories will be downloaded. The time cost can be significantly reduced if the value is 'FALSE'. The parameter only works with bucket/folder.
`depth` | Integer(1), the depth of the recursive download.

### Value

A 'FolderClass' object or a 'FileClass' object

### Examples

    ## List files in a bucket
    ## Equivalent: gcs_dir(path = "gs://genomics-public-data/")
    gcs_dir(path = "genomics-public-data/")

    ## List files in a folder
    gcs_dir(path = "genomics-public-data/clinvar/")

    ## List the information of a file
    gcs_dir(path = "genomics-public-data/clinvar/README.txt")

[Package GCSConnection version 1.0.1 Index]