diff --git a/404.html b/404.html index 24fc2dd..9f85759 100644 --- a/404.html +++ b/404.html @@ -189,7 +189,7 @@

Page not found (404)

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index ac3397b..63667da 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -156,7 +156,7 @@

Contributing to the ‘marshal’ package

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/LICENSE-text.html b/LICENSE-text.html index 1e24822..de5e79e 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -153,7 +153,7 @@

License

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/LICENSE.html b/LICENSE.html index e1ae4dd..2cc4907 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -157,7 +157,7 @@

MIT License

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/articles/index.html b/articles/index.html index d1acac4..979e569 100644 --- a/articles/index.html +++ b/articles/index.html @@ -150,7 +150,7 @@

All vignettes

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/articles/known_cases.html b/articles/known_cases.html index 431f1cc..27bc2e4 100644 --- a/articles/known_cases.html +++ b/articles/known_cases.html @@ -2743,8 +2743,8 @@

Known Cases where Marshalling is Needed and -
- +
+ diff --git a/authors.html b/authors.html index dacfe37..71f402f 100644 --- a/authors.html +++ b/authors.html @@ -174,7 +174,7 @@

Citation

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/index.html b/index.html index fe4145c..c928661 100644 --- a/index.html +++ b/index.html @@ -172,6 +172,13 @@

marshal: Unified API for Marshalling R Objects

+

News +

+ +
+

Introduction

Some types of R objects can be used only in the R session they were created. If used as-is in another R process, such objects often result in an immediate error or in obscure and hard-to-troubleshoot outcomes. Because of this, they cannot be saved to file and re-used at a later time. They may also not be exported to a parallel worker when doing parallel processing. These objects are sometimes referred to as non-exportable or non-serializable objects. For example, assume we load an HTML document using the xml2 package:

@@ -318,7 +325,7 @@

Dev status

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/news/index.html b/news/index.html index 8ca5975..3f55233 100644 --- a/news/index.html +++ b/news/index.html @@ -167,7 +167,7 @@

Significant Changes
-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/pkgdown.yml b/pkgdown.yml index 621ffa5..17141d4 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.7 pkgdown_sha: ~ articles: known_cases: known_cases.html -last_built: 2024-04-19T01:04Z +last_built: 2024-05-29T21:01Z urls: reference: https://marshal.futureverse.org/reference article: https://marshal.futureverse.org/articles diff --git a/reference/find_references.html b/reference/find_references.html index 188fbfa..ea50952 100644 --- a/reference/find_references.html +++ b/reference/find_references.html @@ -196,7 +196,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/index.html b/reference/index.html index bcee0b5..0d10cc4 100644 --- a/reference/index.html +++ b/reference/index.html @@ -259,7 +259,7 @@

All functions
-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal-package.html b/reference/marshal-package.html index 82b8470..1f4d655 100644 --- a/reference/marshal-package.html +++ b/reference/marshal-package.html @@ -165,7 +165,7 @@

Author

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.DBI.html b/reference/marshal.DBI.html index 1808b77..b977e8b 100644 --- a/reference/marshal.DBI.html +++ b/reference/marshal.DBI.html @@ -179,7 +179,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.XML.html b/reference/marshal.XML.html index 6cfbcfe..677f39d 100644 --- a/reference/marshal.XML.html +++ b/reference/marshal.XML.html @@ -223,7 +223,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.bigmemory.html b/reference/marshal.bigmemory.html index 7003214..6d3723f 100644 --- a/reference/marshal.bigmemory.html +++ b/reference/marshal.bigmemory.html @@ -151,7 +151,7 @@

Marshalling of 'bigmemory' objects

Arguments

x
-

A bigmemory::big.matrix object.

+

A bigmemory::big.matrix object.

...
@@ -166,9 +166,9 @@

Value

Details

-

bigmemory::write.big.matrix() is used to produce a marshalled version +

bigmemory::write.big.matrix() is used to produce a marshalled version of the original object. -bigmemory::read.big.matrix() is used to reconstruct a version of the +bigmemory::read.big.matrix() is used to reconstruct a version of the original object from the marshalled object.

@@ -177,7 +177,7 @@

Examples

if (requireNamespace("bigmemory", quietly = TRUE)) {
   library(bigmemory)
   
-  x <- big.matrix(nrow = 3, ncol = 2, type = "double")
+  x <- big.matrix(nrow = 3, ncol = 2, type = "double")
   x[] <- seq_along(x)
   
   ## Marshal
@@ -203,7 +203,7 @@ 
Examples
-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.caret.html b/reference/marshal.caret.html index 50785a2..d2d7805 100644 --- a/reference/marshal.caret.html +++ b/reference/marshal.caret.html @@ -151,7 +151,7 @@

Marshalling of 'caret:train' objects

Arguments

train
-

A caret::train object.

+

A caret::train object.

...
@@ -166,9 +166,9 @@

Value

Details

-

bundle::bundle() is used to produce a marshalled version +

bundle::bundle() is used to produce a marshalled version of the original object. -bundle::unbundle() is used to reconstruct a version of the +bundle::unbundle() is used to reconstruct a version of the original object from the marshalled object.

@@ -184,7 +184,7 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.connection.html b/reference/marshal.connection.html index a7dd52a..459a01e 100644 --- a/reference/marshal.connection.html +++ b/reference/marshal.connection.html @@ -267,7 +267,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.data.table.html b/reference/marshal.data.table.html index a8df67f..b3ebda4 100644 --- a/reference/marshal.data.table.html +++ b/reference/marshal.data.table.html @@ -202,7 +202,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.default.html b/reference/marshal.default.html index d5d65f4..7f19260 100644 --- a/reference/marshal.default.html +++ b/reference/marshal.default.html @@ -193,7 +193,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.h2o.html b/reference/marshal.h2o.html index d0e1ae0..c969813 100644 --- a/reference/marshal.h2o.html +++ b/reference/marshal.h2o.html @@ -184,9 +184,9 @@

Value

Details

-

h2o::h2o.save_mojo() and h2o::h2o.saveModel() are used to produce +

h2o::h2o.save_mojo() and h2o::h2o.saveModel() are used to produce a marshalled version of the original object. -h2o::h2o.import_mojo() and h2o::h2o.loadModel() are used to +h2o::h2o.import_mojo() and h2o::h2o.loadModel() are used to reconstruct a version of the original object from the marshalled object.

@@ -202,7 +202,7 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.html b/reference/marshal.html index e7210dd..65a0d27 100644 --- a/reference/marshal.html +++ b/reference/marshal.html @@ -176,7 +176,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.inline.html b/reference/marshal.inline.html index 138ccee..5f65f45 100644 --- a/reference/marshal.inline.html +++ b/reference/marshal.inline.html @@ -151,7 +151,7 @@

Marshalling of 'inline' objects

Arguments

inline
-

A CFunc function.

+

A CFunc function.

...
@@ -176,7 +176,7 @@

Examples

int i; for (i = 0; i < *n; i++) x[0] = x[0] + (i+1); " - sum_1_to_n <- inline::cfunction( + sum_1_to_n <- inline::cfunction( signature(n = "integer", x = "numeric"), code, language = "C", convention = ".C" @@ -194,8 +194,6 @@

Examples

y2 <- sum_1_to_n2(10, 0)$x print(y2) } -#> [1] 55 -#> [1] 55
@@ -210,7 +208,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.keras.html b/reference/marshal.keras.html index 6a2d7aa..38d085a 100644 --- a/reference/marshal.keras.html +++ b/reference/marshal.keras.html @@ -151,7 +151,7 @@

Marshalling of 'keras' objects

Arguments

model
-

A keras:keras.engine.base_layer.Layer object.

+

A keras:keras.engine.base_layer.Layer object.

...
@@ -166,9 +166,9 @@

Value

Details

-

keras::serialize_model() is used to produce a marshalled version +

keras::serialize_model() is used to produce a marshalled version of the original object. -keras::unserialize_model() is used to reconstruct a version of the +keras::unserialize_model() is used to reconstruct a version of the original object from the marshalled object.

@@ -180,10 +180,10 @@

Examples

library(keras) ## Create a keras model (adopted from {keras} vignette) - inputs <- layer_input(shape = shape(32)) - outputs <- layer_dense(inputs, units = 1L) - model <- keras_model(inputs, outputs) - model <- compile(model, optimizer = "adam", loss = "mean_squared_error") + inputs <- layer_input(shape = shape(32)) + outputs <- layer_dense(inputs, units = 1L) + model <- keras_model(inputs, outputs) + model <- compile(model, optimizer = "adam", loss = "mean_squared_error") print(model) ## Not needed anymore @@ -203,7 +203,7 @@

Examples

## Fitted keras model (adopted from {keras} vignette) test_input <- array(runif(128 * 32), dim = c(128, 32)) test_target <- array(runif(128), dim = c(128, 1)) - hist <- fit(model, test_input, test_target) + hist <- fit(model, test_input, test_target) print(hist) print(model) @@ -235,7 +235,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.magick.html b/reference/marshal.magick.html index 3cbc3f0..ac36b42 100644 --- a/reference/marshal.magick.html +++ b/reference/marshal.magick.html @@ -153,7 +153,7 @@

Marshalling of 'magick' objects (not supported)

Arguments

x
-

A magick:magick-image object.

+

A magick:magick-image object.

...
@@ -179,7 +179,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.ncdf4.html b/reference/marshal.ncdf4.html index 3fbb013..183b26d 100644 --- a/reference/marshal.ncdf4.html +++ b/reference/marshal.ncdf4.html @@ -151,7 +151,7 @@

Marshalling of 'ncdf4' objects

Arguments

x
-

A ncdf4:ncdf4 object.

+

A ncdf4:ncdf4 object.

...
@@ -168,7 +168,7 @@

Value

Details

base::readBin() is used to produce a marshalled version of the original object. -base::writeBin() and ncdf4::nc_open() are used to +base::writeBin() and ncdf4::nc_open() are used to reconstruct a version of the original object from the marshalled object.

@@ -181,16 +181,16 @@

Examples

## Create a temporary NCDF file tf <- tempfile(fileext = ".nc") - x <- ncvar_def("x", units = "count", dim = list()) - nf <- nc_create(tf, x) - ncvar_put(nf, x, 42) + x <- ncvar_def("x", units = "count", dim = list()) + nf <- nc_create(tf, x) + ncvar_put(nf, x, 42) print(nf) - nc_close(nf) + nc_close(nf) rm(list = c("nf", "x")) ## Open NCDF file - nf <- nc_open(tf) - y <- ncvar_get(nf, "x") + nf <- nc_open(tf) + y <- ncvar_get(nf, "x") ## Marshal nf_ <- marshal(nf) @@ -198,16 +198,9 @@

Examples

## Unmarshal nf2 <- unmarshal(nf_) - y2 <- ncvar_get(nf2, "x") + y2 <- ncvar_get(nf2, "x") stopifnot(identical(y2, y)) } -#> File /tmp/henrik/RtmpsiqPZl/file725b87bc1a9b.nc (NC_FORMAT_CLASSIC): -#> -#> 1 variables (excluding dimension variables): -#> float x[] -#> units: count -#> -#> 0 dimensions: @@ -222,7 +215,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.parallel.html b/reference/marshal.parallel.html index 153d411..c4daf96 100644 --- a/reference/marshal.parallel.html +++ b/reference/marshal.parallel.html @@ -165,7 +165,7 @@

Marshalling of 'parallel' objects (not supported)

Arguments

x
-

A magick:magick-image object.

+

A magick:magick-image object.

...
@@ -191,7 +191,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.parsnip.html b/reference/marshal.parsnip.html index d4fa4fb..ea91b6b 100644 --- a/reference/marshal.parsnip.html +++ b/reference/marshal.parsnip.html @@ -175,9 +175,9 @@

Examples

library(parsnip) ## Adopted from example("boost_tree", package = "parsnip") - model <- boost_tree(mode = "classification", trees = 20L, engine = "xgboost") - model <- set_mode(model, "regression") - fit <- fit(model, mpg ~ ., data = datasets::mtcars) + model <- boost_tree(mode = "classification", trees = 20L, engine = "xgboost") + model <- set_mode(model, "regression") + fit <- fit(model, mpg ~ ., data = datasets::mtcars) ## Marshal fit_ <- marshal(fit) @@ -200,7 +200,6 @@

Examples

all.equal(fit3, fit2) ) } -#> Error in assert_no_references(res): Detected a non-exportable reference (‘externalptr’ of class ‘xgb.Booster.handle’) in one of the globals (‘marshalled’ of class ‘_xgb.Booster’) used in the future expression @@ -215,7 +214,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.rJava.html b/reference/marshal.rJava.html index 9913a4e..7f124d8 100644 --- a/reference/marshal.rJava.html +++ b/reference/marshal.rJava.html @@ -185,7 +185,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.raster.html b/reference/marshal.raster.html index 602abae..1fd58f5 100644 --- a/reference/marshal.raster.html +++ b/reference/marshal.raster.html @@ -215,7 +215,7 @@

Examples

#> resolution : 40, 40 (x, y) #> extent : 178400, 181600, 329400, 334000 (xmin, xmax, ymin, ymax) #> crs : +proj=sterea +lat_0=52.1561605555556 +lon_0=5.38763888888889 +k=0.9999079 +x_0=155000 +y_0=463000 +datum=WGS84 +units=m +no_defs -#> source : file725b87cb086c7.grd +#> source : file155c930f3e60f.grd #> names : test #> values : 139, 1736 (min, max) #> @@ -233,7 +233,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.reticulate.html b/reference/marshal.reticulate.html index ff6b0ba..de50978 100644 --- a/reference/marshal.reticulate.html +++ b/reference/marshal.reticulate.html @@ -179,7 +179,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.rstan.html b/reference/marshal.rstan.html index 792bf3e..8a1efc3 100644 --- a/reference/marshal.rstan.html +++ b/reference/marshal.rstan.html @@ -177,7 +177,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.sparklyr.html b/reference/marshal.sparklyr.html index 73f45e7..03338b0 100644 --- a/reference/marshal.sparklyr.html +++ b/reference/marshal.sparklyr.html @@ -179,7 +179,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.terra.html b/reference/marshal.terra.html index 69fffd8..d6e4fa5 100644 --- a/reference/marshal.terra.html +++ b/reference/marshal.terra.html @@ -201,7 +201,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.torch.html b/reference/marshal.torch.html index fb7258e..2f774ea 100644 --- a/reference/marshal.torch.html +++ b/reference/marshal.torch.html @@ -166,9 +166,9 @@

Value

Details

-

luz::luz_save() is used to produce a marshalled version +

luz::luz_save() is used to produce a marshalled version of the original object. -luz::luz_load() is used to reconstruct a version of the +luz::luz_load() is used to reconstruct a version of the original object from the marshalled object.

@@ -184,7 +184,7 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.udpipe.html b/reference/marshal.udpipe.html index bc9b2b1..f48c779 100644 --- a/reference/marshal.udpipe.html +++ b/reference/marshal.udpipe.html @@ -179,7 +179,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.xgboost.html b/reference/marshal.xgboost.html index 728ffdd..e20afd0 100644 --- a/reference/marshal.xgboost.html +++ b/reference/marshal.xgboost.html @@ -157,7 +157,7 @@

Marshalling of 'xgboost' objects

Arguments

x
-

An xgboost::xgb.DMatrix or an xgboost:xgb.Booster object.

+

An xgboost::xgb.DMatrix or an xgboost:xgb.Booster object.

...
@@ -172,9 +172,9 @@

Value

Details

-

xgboost::xgb.DMatrix.save() is used to produce a marshalled version +

xgboost::xgb.DMatrix.save() is used to produce a marshalled version of the original object. -xgboost::xgb.DMatrix() is used to reconstruct a version of the +xgboost::xgb.DMatrix() is used to reconstruct a version of the original object from the marshalled object.

@@ -190,7 +190,7 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshal.xml2.html b/reference/marshal.xml2.html index 316d64e..3943150 100644 --- a/reference/marshal.xml2.html +++ b/reference/marshal.xml2.html @@ -205,7 +205,7 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

diff --git a/reference/marshallable.html b/reference/marshallable.html index 275e50e..e06daa9 100644 --- a/reference/marshallable.html +++ b/reference/marshallable.html @@ -172,7 +172,7 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9005.

+

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.