check_schema_df: Check a data frame of data against a JSON Schema

Description Usage Arguments Value Examples

View source: R/check-schema-df.R

Description

Each row of the data frame will be converted to JSON and validated against the given schema.

Usage

1
2
3
4
5
6
check_schema_df(
  df,
  schema,
  success_msg = "Data is valid against the schema",
  fail_msg = "Data is invalid against the schema"
)

Arguments

df

A data frame whose rows will be converted into JSON and validated

schema

Contents of the json schema, or a filename containing a schema.

success_msg

Message indicating the check succeeded.

fail_msg

Message indicating the check failed.

Value

A condition object indicating whether the data is valid against the schema.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
if (requireNamespace("jsonvalidate", quietly = TRUE) &
      requireNamespace("jsonlite", quietly = TRUE)) {
dat <- data.frame(
  x = c(NA, 1, NA),
  y = c(NA, NA, "foo")
)
schema <- '{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "x": {
      "type": "integer"
    },
    "y": {
      "type": "integer"
    }
  },
  "required": ["x", "y"]
}
'
check_schema_df(dat, schema)
}

dccvalidator documentation built on July 2, 2020, 4:05 a.m.