Skip to contents

FileSet: a set of files matched by glob patterns

Usage

FileSet(
  id = NULL,
  name = NULL,
  description = NULL,
  encoding_format = NULL,
  includes = NULL,
  excludes = NULL,
  contained_in = NULL,
  other_properties = NULL
)

Arguments

id

Optional Character: @id, unique within the document.

name

Optional Character: Name, or a character vector named by language tag.

description

Optional Character: Description, or a character vector named by language tag.

encoding_format

Optional Character: MIME types of the files.

includes

Optional Character: Glob patterns of the files included.

excludes

Optional Character: Glob patterns of the files excluded.

contained_in

Optional Character: @id of each FileObject or FileSet the files are extracted from. A containedIn given as a source with a transform is kept in other_properties.

other_properties

Optional List: Properties without a typed counterpart, keyed by canonical JSON-LD key, with their parsed JSON values.

Value

FileSet object.

Author

EDG

Examples

FileSet(
  id = "images",
  contained_in = "archive.zip",
  encoding_format = "image/jpeg",
  includes = "*.jpg"
)
#> <croissant::FileSet>
#>  @ id              : chr "images"
#>  @ name            : NULL
#>  @ description     : NULL
#>  @ encoding_format : chr "image/jpeg"
#>  @ includes        : chr "*.jpg"
#>  @ excludes        : NULL
#>  @ contained_in    : chr "archive.zip"
#>  @ other_properties: NULL