properties_dataresource: Getting and setting properties of Data Resources

In djvanderlaan/datapackage: Creating and Reading Data Packages

Getting and setting properties of Data Resources

Description

Getting and setting properties of Data Resources

Usage

## S3 method for class 'dataresource'
dp_name(x)

## S3 replacement method for class 'dataresource'
dp_name(x) <- value

## S3 method for class 'dataresource'
dp_title(x)

## S3 replacement method for class 'dataresource'
dp_title(x) <- value

## S3 method for class 'dataresource'
dp_description(x, ..., first_paragraph = FALSE, dots = FALSE)

## S3 replacement method for class 'dataresource'
dp_description(x) <- value

dp_path(x, ...)

dp_path(x) <- value

## S3 method for class 'dataresource'
dp_path(x, full_path = FALSE, ...)

## S3 replacement method for class 'dataresource'
dp_path(x) <- value

dp_format(x, ...)

dp_format(x) <- value

## S3 method for class 'dataresource'
dp_format(x, default = FALSE, ...)

## S3 replacement method for class 'dataresource'
dp_format(x) <- value

dp_mediatype(x, ...)

dp_mediatype(x) <- value

## S3 method for class 'dataresource'
dp_mediatype(x, ...)

## S3 replacement method for class 'dataresource'
dp_mediatype(x) <- value

dp_encoding(x, default = FALSE, ...)

dp_encoding(x) <- value

## S3 method for class 'dataresource'
dp_encoding(x, default = FALSE, ...)

## S3 replacement method for class 'dataresource'
dp_encoding(x) <- value

dp_bytes(x, ...)

dp_bytes(x) <- value

## S3 method for class 'dataresource'
dp_bytes(x, ...)

## S3 replacement method for class 'dataresource'
dp_bytes(x) <- value

dp_hash(x, ...)

dp_hash(x) <- value

## S3 method for class 'dataresource'
dp_hash(x, ...)

## S3 replacement method for class 'dataresource'
dp_hash(x) <- value

## S3 replacement method for class 'fielddescriptor'
dp_name(x) <- value

## S3 replacement method for class 'fielddescriptor'
dp_title(x) <- value

## S3 method for class 'fielddescriptor'
dp_description(x, ..., first_paragraph = FALSE, dots = FALSE)

## S3 replacement method for class 'fielddescriptor'
dp_format(x) <- value

## S3 replacement method for class 'fielddescriptor'
dp_type(x) <- value

dp_schema(x)

## S3 method for class 'dataresource'
dp_schema(x)

Arguments

x	a dataresource object.
value	the new value of the property.
...	used to pass additional arguments to other methods.
first_paragraph	Only return the first paragraph of the description.
dots	When returning only the first paragraph indicate missing paragraphs with ....
full_path	Return the full path including the path to the Data Package and not only the path relative to the Data Package. This is only relevant for relative paths.
default	return the default value if the property had a default value and the property is not set.

Value

Either returns the property or modifies the object. If the property of not set NULL is returned (unless default = TRUE).

See Also

See PropertiesDatapackage and PropertiesFielddescriptor for methods for Data Packages and Field Descriptors respectively. Also see dp_property for a generic method for getting and setting properties. These functions can also be used to get and set 'unofficial' properties'

djvanderlaan/datapackage documentation built on June 12, 2025, 2:44 a.m.