codebook: Create PsychDS Codebook from Data

In faux: Simulation for Factorial Designs

Create PsychDS Codebook from Data

Description

See vignette("codebook", package = "faux") for details.

Usage

codebook(
  data,
  name = NULL,
  vardesc = list(),
  ...,
  schemaVersion = "Psych-DS 0.1.0",
  return = c("json", "list", "data"),
  interactive = FALSE
)

Arguments

data	The data frame to generate a codebook for
name	The name of this dataset (if NULL, will be the same as 'data', limited to 64 characters)
vardesc	Optional variable properties in the format of a named list of vectors (can be named or unnamed and in the same order as the data) from the options "description", "privacy", "dataType", "identifier", "minValue", "maxValue", "levels", "levelsOrdered", "na", "naValue", "alternateName", "privacy", "unitCode", "unitText"
...	Further dataset properties (e.g., description, license, author, citation, funder, url, identifier, keywords, privacyPolicy)
schemaVersion	defaults to "Psych-DS 0.1.0"
return	Whether the output should be in JSON format (json), a list (list) or the reformatted data with the codebook as an attribute (data)
interactive	Whether the function should prompt the user to describe columns and factor levels

Value

a list or json-formatted codebook, or reformatted data with the codebook as an attribute

Examples

vardesc = list(
  description = c("Length of the sepal",
                  "Width of the sepal",
                  "Length of the petal",
                  "Width of the petal",
                  "The flower species"),
  type = c("float", "float", "float", "float", "string")
)
codebook(iris, vardesc = vardesc)

faux documentation built on April 20, 2023, 9:13 a.m.