dpgeneratefielddescriptor: 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

dpgeneratefielddescriptor(x, name, ...)

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

## S3 method for class 'numeric'
dpgeneratefielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_codelist = TRUE,
  ...
)

## S3 method for class 'integer'
dpgeneratefielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_codelist = TRUE,
  ...
)

## S3 method for class 'logical'
dpgeneratefielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_codelist = TRUE,
  ...
)

## S3 method for class 'Date'
dpgeneratefielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_codelist = TRUE,
  ...
)

## S3 method for class 'character'
dpgeneratefielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_codelist = TRUE,
  ...
)

## S3 method for class 'factor'
dpgeneratefielddescriptor(
  x,
  name,
  use_existing = TRUE,
  use_codelist = TRUE,
  ...
)

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 of present (assumed this is stored in the 'fielddescriptor' attribute.
use_codelist	use existing code list of x if available. The code list is obtained using dpcodelist.

Value

Returns a list with two fields: fielddescriptor and optionally codelist. The first contains the fielddescriptor object and the second the optional code list for the field.

djvanderlaan/datapackage documentation built on March 18, 2024, 4:57 p.m.