Skip to contents

FileObject: a single file of the dataset

Usage

FileObject(
  id = NULL,
  name = NULL,
  description = NULL,
  content_url = NULL,
  content_size = NULL,
  encoding_format = NULL,
  sha256 = NULL,
  md5 = NULL,
  contained_in = NULL,
  same_as = NULL,
  source = 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.

content_url

Optional Character: URL or relative path of the file.

content_size

Optional Character: Size, such as "117743 B".

encoding_format

Optional Character: MIME types, such as "text/csv".

sha256

Optional Character: SHA-256 checksum.

md5

Optional Character: MD5 checksum.

contained_in

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

same_as

Optional Character: URLs of the same file elsewhere.

source

Optional Source object: The file this file is derived from.

other_properties

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

Value

FileObject object.

Author

EDG

Examples

FileObject(
  id = "passengers.csv",
  content_url = "data/titanic.csv",
  encoding_format = "text/csv"
)
#> <croissant::FileObject>
#>  @ id              : chr "passengers.csv"
#>  @ name            : NULL
#>  @ description     : NULL
#>  @ content_url     : chr "data/titanic.csv"
#>  @ content_size    : NULL
#>  @ encoding_format : chr "text/csv"
#>  @ sha256          : NULL
#>  @ md5             : NULL
#>  @ contained_in    : NULL
#>  @ same_as         : NULL
#>  @ source          : NULL
#>  @ other_properties: NULL