Tag an atomic vector with a single element as class 'scalar'. When output to JSON it will be output as a scalar not a vector

Description

Tag an atomic vector with a single element as class 'scalar'. When output to JSON it will be output as a scalar not a vector

Usage

as_scalar(x)

Arguments

Value

If x is an atomic vector with length = 1, then object is returned with class 'scalar', otherwise object is returned unmodified

Options for reading in GeoJSON

Description

Options for reading in GeoJSON

Usage

opts_read_geojson(
  type = c("sf", "sfc"),
  property_promotion = c("string", "list"),
  property_promotion_lgl = c("integer", "string")
)

Arguments

Value

Named list of options specific to reading GeoJSON

Examples

# Create a set of options to use when reading geojson
opts_read_geojson()

Create named list of options for parsing R from JSON

Description

Create named list of options for parsing R from JSON

Usage

opts_read_json(
  promote_num_to_string = FALSE,
  digits_promote = 6,
  df_missing_list_elem = NULL,
  obj_of_arrs_to_df = TRUE,
  arr_of_objs_to_df = TRUE,
  str_specials = c("string", "special"),
  num_specials = c("special", "string"),
  int64 = c("string", "double", "bit64"),
  length1_array_asis = FALSE,
  single_null = NULL,
  yyjson_read_flag = 0L
)

Arguments

Value

Named list of options for reading JSON

See Also

yyjson_read_flag()

Examples

opts_read_json()

Options for writing from sf object to GeoJSON

Description

Currently no options available.

Usage

opts_write_geojson()

Value

Named list of options specific to writing GeoJSON

Examples

# Create a set of options to use when writing geojson
opts_write_geojson()

Create named list of options for serializing R to JSON

Description

Create named list of options for serializing R to JSON

Usage

opts_write_json(
  digits = -1L,
  digits_secs = 0L,
  digits_signif = -1L,
  pretty = FALSE,
  auto_unbox = FALSE,
  dataframe = c("rows", "columns"),
  factor = c("string", "integer"),
  name_repair = c("none", "minimal"),
  num_specials = c("null", "string"),
  str_specials = c("null", "string"),
  fast_numerics = FALSE,
  json_verbatim = FALSE,
  yyjson_write_flag = 0L
)

Arguments

Value

Named list of options for writing JSON

See Also

yyjson_write_flag()

Examples

write_json_str(head(iris, 3), opts = opts_write_json(factor = 'integer'))

Load GeoJSON as sf object

Description

Coordinate reference system is always WGS84 in accordance with GeoJSON RFC.

Usage

read_geojson_str(str, opts = list(), ..., json_opts = list())

read_geojson_file(filename, opts = list(), ..., json_opts = list())

Arguments

Value

sf object

Examples

geojson_file <- system.file("geojson-example.json", package = 'yyjsonr')
read_geojson_file(geojson_file)

Parse JSON from an R connection object.

Description

Currently, this is not very efficient as the entire contents of the connection are read into R as a string and then the JSON parsed from there.

Usage

read_json_conn(conn, opts = list(), ...)

Arguments

Details

For plain text files it is faster to use read_json_file().

Value

R object

See Also

Other JSON Parsers: read_json_file(), read_json_raw(), read_json_str(), read_ndjson_file(), read_ndjson_raw(), read_ndjson_str()

Examples

if (interactive()) {
  read_json_conn(url("https://api.github.com/users/hadley/repos"))
}

Convert JSON to R

Description

Convert JSON to R

Usage

read_json_file(filename, opts = list(), ...)

Arguments

Value

R object

See Also

Other JSON Parsers: read_json_conn(), read_json_raw(), read_json_str(), read_ndjson_file(), read_ndjson_raw(), read_ndjson_str()

Examples

tmp <- tempfile()
write_json_file(head(iris, 3), tmp)
read_json_file(tmp)

Convert JSON in a raw vector to R

Description

Convert JSON in a raw vector to R

Usage

read_json_raw(raw_vec, opts = list(), ...)

Arguments

Value

R object

See Also

Other JSON Parsers: read_json_conn(), read_json_file(), read_json_str(), read_ndjson_file(), read_ndjson_raw(), read_ndjson_str()

Examples

raw_str <- as.raw(utf8ToInt('[1, 2, 3, "four"]'))
read_json_raw(raw_str)

Convert JSON in a character string to R

Description

Convert JSON in a character string to R

Usage

read_json_str(str, opts = list(), ...)

Arguments

Value

R object

See Also

Other JSON Parsers: read_json_conn(), read_json_file(), read_json_raw(), read_ndjson_file(), read_ndjson_raw(), read_ndjson_str()

Examples

read_json_str("4294967297", opts = opts_read_json(int64 = 'string'))

Parse an NDJSON file to a data.frame or list

Description

If reading as data.frame, each row of NDJSON becomes a row in the data.frame. If reading as a list, then each row becomes an element in the list.

Usage

read_ndjson_file(
  filename,
  type = c("df", "list"),
  nread = -1,
  nskip = 0,
  nprobe = 100,
  opts = list(),
  ...
)

Arguments

Details

If parsing NDJSON to a data.frame it is usually better if the json objects are consistent from line-to-line. Type inference for the data.frame is done during initialisation by reading through nprobe lines. Warning: if there is a type-mismatch further into the file than it is probed, then you will get missing values in the data.frame, or JSON values not captured in the R data.

No flattening of the namespace is done i.e. nested object remain nested.

Value

NDJSON data read into R as list or data.frame depending on 'type' argument

See Also

Other JSON Parsers: read_json_conn(), read_json_file(), read_json_raw(), read_json_str(), read_ndjson_raw(), read_ndjson_str()

Examples

tmp <- tempfile()
write_ndjson_file(head(mtcars), tmp)
read_ndjson_file(tmp)

Parse an NDJSON within a raw vector to a data.frame or list

Description

If reading as data.frame, each row of NDJSON becomes a row in the data.frame. If reading as a list, then each row becomes an element in the list.

Usage

read_ndjson_raw(
  x,
  type = c("df", "list"),
  nread = -1,
  nskip = 0,
  nprobe = 100,
  opts = list(),
  ...
)

Arguments

Details

If parsing NDJSON to a data.frame it is usually better if the json objects are consistent from line-to-line. Type inference for the data.frame is done during initialisation by reading through nprobe lines. Warning: if there is a type-mismatch further into the file than it is probed, then you will get missing values in the data.frame, or JSON values not captured in the R data.

No flattening of the namespace is done i.e. nested object remain nested.

Value

NDJSON data read into R as list or data.frame depending on 'type' argument

See Also

Other JSON Parsers: read_json_conn(), read_json_file(), read_json_raw(), read_json_str(), read_ndjson_file(), read_ndjson_str()

Examples

js <- write_ndjson_raw(head(mtcars))
js
read_ndjson_raw(js, 'list')
read_ndjson_raw(js, 'df')

Parse an NDJSON string to a data.frame or list

Description

If reading as data.frame, each row of NDJSON becomes a row in the data.frame. If reading as a list, then each row becomes an element in the list.

Usage

read_ndjson_str(
  x,
  type = c("df", "list"),
  nread = -1,
  nskip = 0,
  nprobe = 100,
  opts = list(),
  ...
)

Arguments

Details

If parsing NDJSON to a data.frame it is usually better if the json objects are consistent from line-to-line. Type inference for the data.frame is done during initialisation by reading through nprobe lines. Warning: if there is a type-mismatch further into the file than it is probed, then you will get missing values in the data.frame, or JSON values not captured in the R data.

No flattening of the namespace is done i.e. nested object remain nested.

Value

NDJSON data read into R as list or data.frame depending on 'type' argument

See Also

Other JSON Parsers: read_json_conn(), read_json_file(), read_json_raw(), read_json_str(), read_ndjson_file(), read_ndjson_raw()

Examples

tmp <- tempfile()
json <- write_ndjson_str(head(mtcars))
read_ndjson_str(json, type = 'list')

Validate JSON in file or string

Description

Validate JSON in file or string

Usage

validate_json_file(filename, verbose = FALSE, opts = list(), ...)

validate_json_str(str, verbose = FALSE, opts = list(), ...)

Arguments

Value

Logical value. TRUE if JSON validates as OK, otherwise FALSE

Examples

tmp <- tempfile()
write_json_file(head(iris, 3), tmp)
validate_json_file(tmp)
str <- write_json_str(iris)
validate_json_str(str)

Write SF to GeoJSON string

Description

Coordinate reference system is always WGS84 in accordance with GeoJSON RFC.

Usage

write_geojson_str(x, opts = list(), ..., json_opts = list())

write_geojson_file(x, filename, opts = list(), ..., json_opts = list())

Arguments

Value

Character string containing GeoJSON, or NULL if GeoJSON written to file.

Examples

geojson_file <- system.file("geojson-example.json", package = 'yyjsonr')
sf <- read_geojson_file(geojson_file)
cat(write_geojson_str(sf, json_opts = opts_write_json(pretty = TRUE)))

Convert R object to JSON file

Description

Convert R object to JSON file

Usage

write_json_file(x, filename, opts = list(), ...)

Arguments

Value

None

See Also

Other JSON Serializer: write_json_raw(), write_json_str(), write_ndjson_file(), write_ndjson_raw(), write_ndjson_str()

Examples

tmp <- tempfile()
write_json_file(head(iris, 3), tmp)
read_json_file(tmp)

Convert R object to a raw vector of JSON data

Description

Convert R object to a raw vector of JSON data

Usage

write_json_raw(x, opts = list(), ...)

Arguments

Value

Raw vector containing the JSON

See Also

Other JSON Serializer: write_json_file(), write_json_str(), write_ndjson_file(), write_ndjson_raw(), write_ndjson_str()

Examples

js <- write_json_raw(head(iris, 3))
js
read_json_raw(js)

Convert R object to JSON string

Description

Convert R object to JSON string

Usage

write_json_str(x, opts = list(), ...)

Arguments

Value

Single string containing JSON

See Also

Other JSON Serializer: write_json_file(), write_json_raw(), write_ndjson_file(), write_ndjson_raw(), write_ndjson_str()

Examples

write_json_str(head(iris, 3), pretty = TRUE)

Write list or data.frame object to NDJSON in a file

Description

For list input, each element of the list is written as a single JSON string. For data.frame input, each row of the data.frame is written as aJSON string.

Usage

write_ndjson_file(x, filename, opts = list(), ...)

Arguments

Value

None

See Also

Other JSON Serializer: write_json_file(), write_json_raw(), write_json_str(), write_ndjson_raw(), write_ndjson_str()

Examples

tmp <- tempfile()
write_ndjson_file(head(mtcars), tmp)
read_ndjson_file(tmp)

Write list or data.frame object to NDJSON in a raw vector

Description

For list input, each element of the list is written as a single JSON string. For data.frame input, each row of the data.frame is written as aJSON string.

Usage

write_ndjson_raw(x, opts = list(), ...)

Arguments

Value

Raw vector containing NDJSON character data

See Also

Other JSON Serializer: write_json_file(), write_json_raw(), write_json_str(), write_ndjson_file(), write_ndjson_str()

Examples

js <- write_ndjson_raw(head(mtcars))
js
read_ndjson_raw(js, 'list')

Write list or data.frame object to NDJSON in a string

Description

For list input, each element of the list is written as a single JSON string. For data.frame input, each row of the data.frame is written as aJSON string.

Usage

write_ndjson_str(x, opts = list(), ...)

Arguments

Value

String containing multiple JSON strings separated by newlines.

See Also

Other JSON Serializer: write_json_file(), write_json_raw(), write_json_str(), write_ndjson_file(), write_ndjson_raw()

Examples

write_ndjson_str(head(mtcars))

Advanced: Values for setting internal options directly on YYJSON library

Description

This is a list of integer values used for setting flags on the yyjson code directly. This is an ADVANCED option and should be used with caution.

Usage

yyjson_read_flag

Format

An object of class list of length 9.

Details

Some of these settings overlap and conflict with code needed to handle the translation of JSON values to R.

opts_read_json(yyjson_read_flag = c(yyjson_read_flag$x, yyjson_read_flag$y, ...))

YYJSON_READ_NOFLAG

Default option (RFC 8259 compliant):

• Read positive integer as uint64_t.

• Read negative integer as int64_t.

• Read floating-point number as double with round-to-nearest mode.

• Read integer which cannot fit in uint64_t or int64_t as double.

• Report error if double number is infinity.

• Report error if string contains invalid UTF-8 character or BOM.

• Report error on trailing commas, comments, inf and nan literals.

YYJSON_READ_INSITU

Read the input data in-situ. This option allows the reader to modify and use input data to store string values, which can increase reading speed slightly. The caller should hold the input data before free the document. The input data must be padded by at least YYJSON_PADDING_SIZE bytes. For example: "[1,2]" should be "[1,2]\0\0\0\0", input length should be 5.

YYJSON_READ_STOP_WHEN_DONE

Stop when done instead of issuing an error if there's additional content after a JSON document. This option may be used to parse small pieces of JSON in larger data, such as "NDJSON"

YYJSON_READ_ALLOW_TRAILING_COMMAS

Allow single trailing comma at the end of an object or array, such as "[1,2,3,]"

YYJSON_READ_ALLOW_COMMENTS

Allow C-style single line and multiple line comments (non-standard).

YYJSON_READ_ALLOW_INF_AND_NAN

Allow inf/nan number and literal, case-insensitive, such as 1e999, NaN, inf, -Infinity (non-standard).

YYJSON_READ_NUMBER_AS_RAW

Read all numbers as raw strings (value with "YYJSON_TYPE_RAW" type), inf/nan literal is also read as raw with "ALLOW_INF_AND_NAN" flag.

YYJSON_READ_ALLOW_INVALID_UNICODE

Allow reading invalid unicode when parsing string values (non-standard). Invalid characters will be allowed to appear in the string values, but invalid escape sequences will still be reported as errors. This flag does not affect the performance of correctly encoded strings. WARNING: Strings in JSON values may contain incorrect encoding when this option is used, you need to handle these strings carefully to avoid security risks.

YYJSON_READ_BIGNUM_AS_RAW

Read big numbers as raw strings. These big numbers include integers that cannot be represented by "int64_t" and "uint64_t", and floating-point numbers that cannot be represented by finite "double". The flag will be overridden by "YYJSON_READ_NUMBER_AS_RAW" flag.

Examples

read_json_str(
   '[12.3]', 
   opts = opts_read_json(yyjson_read_flag = yyjson_read_flag$YYJSON_READ_ALLOW_TRAILING_COMMAS)
 )

Version number of 'yyjson' C library

Description

Version number of 'yyjson' C library

Usage

yyjson_version()

Value

Version of included yyjson C library as a string

Examples

yyjson_version()

Advanced: Values for setting internal options directly on YYJSON library

Description

This is a list of integer values used for setting flags on the yyjson code directly. This is an ADVANCED option and should be used with caution.

Usage

yyjson_write_flag

Format

An object of class list of length 9.

Details

Some of these settings overlap and conflict with code needed to handle the translation of JSON values to R.

opts_write_json(yyjson_write_flag = c(write_flag$x, write_flag$y, ...))

YYJSON_WRITE_NOFLAG

Default value.

• Write JSON minify.

• Report error on inf or nan number.

• Report error on invalid UTF-8 string.

• Do not escape unicode or slash.

YYJSON_WRITE_PRETTY

Write JSON pretty with 4 space indent.

YYJSON_WRITE_ESCAPE_UNICODE

Escape unicode as uXXXX, make the output ASCII only.

YYJSON_WRITE_ESCAPE_SLASHES

Escape '/' as '\/'.

YYJSON_WRITE_ALLOW_INF_AND_NAN

Write inf and nan number as 'Infinity' and 'NaN' literal (non-standard).

YYJSON_WRITE_INF_AND_NAN_AS_NULL

Write inf and nan number as null literal. This flag will override YYJSON_WRITE_ALLOW_INF_AND_NAN flag.

YYJSON_WRITE_ALLOW_INVALID_UNICODE

Allow invalid unicode when encoding string values (non-standard). Invalid characters in string value will be copied byte by byte. If YYJSON_WRITE_ESCAPE_UNICODE flag is also set, invalid character will be escaped as U+FFFD (replacement character). This flag does not affect the performance of correctly encoded strings.

YYJSON_WRITE_PRETTY_TWO_SPACES

Write JSON pretty with 2 space indent. This flag will override YYJSON_WRITE_PRETTY flag.

YYJSON_WRITE_NEWLINE_AT_END

Adds a newline character at the end of the JSON. This can be helpful for text editors or NDJSON

Examples

write_json_str("hello/there", opts = opts_write_json(
  yyjson_write_flag = yyjson_write_flag$YYJSON_WRITE_ESCAPE_SLASHES
))