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

In djvanderlaan/datapackage: Creating and Reading Data Packages

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, ...)

## Default S3 method:
dp_generate_fielddescriptor(x, name, ...)

## S3 method for class 'numeric'
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

## S3 method for class 'integer'
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

## S3 method for class 'logical'
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

## S3 method for class 'Date'
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

## S3 method for class 'character'
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

## S3 method for class 'factor'
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

## S3 method for class 'code'
dp_generate_fielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_categories = TRUE,
  categories_type = c("regular", "resource"),
  ...
)

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.

Value

Returns a fielddescriptor.

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