datapackage (version 0.2.0)

dp_generate_fielddescriptor: Generate a fielddescriptor for a given variable in a dataset

Description

Generate a fielddescriptor for a given variable in a dataset

Usage

dp_generate_fielddescriptor(x, name, ...)
# S3 method for default
dp_generate_fielddescriptor(x, name, ...)
# S3 method for numeric
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)
# S3 method for integer
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)
# S3 method for logical
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)
# S3 method for Date
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)
# S3 method for character
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)
# S3 method for factor
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)
# S3 method for code
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

Value

Returns a fielddescriptor.

Arguments

x

vector for which to generate the fielddescriptor

name

name of the field in the dataset.

...

used to pass extra arguments to methods.

use_existing

use existing field descriptor if present (assumes this is stored in the 'fielddescriptor' attribute).

use_categories

do not generate a categories field except when x is a factor.

categories_type

how should categories be stored. Note that type "resource" is not officially part of the standard.