From d710cc9bf1aa5a7771799059d4fa2145e902e622 Mon Sep 17 00:00:00 2001 From: Henrik Bengtsson Date: Sat, 26 Oct 2024 20:55:32 -0700 Subject: [PATCH] Updated 'gh-pages' from docs/ folder --- 404.html | 26 +-- CONTRIBUTING.html | 30 ++-- LICENSE-text.html | 26 +-- LICENSE.html | 26 +-- articles/index.html | 26 +-- articles/known_cases.html | 4 +- authors.html | 40 ++--- index.html | 119 +++---------- news/index.html | 26 +-- pkgdown.yml | 7 +- reference/Rplot001.png | Bin 1011 -> 0 bytes reference/assert_no_references.html | 8 + reference/find_references.html | 42 +++-- reference/index.html | 28 ++-- reference/marshal-package.html | 26 +-- reference/marshal.DBI.html | 40 ++--- reference/marshal.H2OBinomialModel.html | 8 + reference/marshal.H2OMultinomialModel.html | 8 + reference/marshal.H2ORegressionModel.html | 8 + reference/marshal.SOCK0node.html | 8 + reference/marshal.SOCKnode.html | 8 + reference/marshal.XML.html | 44 ++--- reference/marshal.XMLAbstractDocument.html | 8 + reference/marshal.bigmemory.html | 40 ++--- reference/marshal.caret.html | 40 ++--- reference/marshal.connection.html | 42 ++--- reference/marshal.data.table.html | 40 ++--- reference/marshal.default.html | 38 ++--- reference/marshal.h2o.html | 52 +++--- reference/marshal.html | 34 ++-- reference/marshal.inline.html | 40 ++--- reference/marshal.jobjRef.html | 8 + reference/marshal.keras.html | 40 ++--- reference/marshal.magick.html | 42 ++--- reference/marshal.ncdf4.html | 40 ++--- reference/marshal.parallel.html | 50 +++--- reference/marshal.parsnip.html | 40 ++--- reference/marshal.rJava.html | 44 ++--- reference/marshal.raster.html | 46 +++--- reference/marshal.reticulate.html | 40 ++--- reference/marshal.rstan.html | 40 ++--- reference/marshal.sparklyr.html | 40 ++--- reference/marshal.terra.html | 40 ++--- reference/marshal.torch.html | 40 ++--- reference/marshal.udpipe.html | 40 ++--- reference/marshal.xgb.Booster.html | 8 + reference/marshal.xgboost.html | 44 ++--- reference/marshal.xml2.html | 44 ++--- reference/marshal.xml_nodeset.html | 8 + reference/marshallable.CFunc.html | 8 + reference/marshallable.DBIConnection.html | 8 + reference/marshallable.H2OAutoML.html | 8 + reference/marshallable.H2OBinomialModel.html | 8 + .../marshallable.H2OMultinomialModel.html | 8 + .../marshallable.H2ORegressionModel.html | 8 + reference/marshallable.RasterLayer.html | 8 + reference/marshallable.SOCK0node.html | 8 + reference/marshallable.SOCKcluster.html | 8 + reference/marshallable.SOCKnode.html | 8 + reference/marshallable.SpatVector.html | 8 + .../marshallable.XMLAbstractDocument.html | 8 + reference/marshallable.XMLAbstractNode.html | 8 + reference/marshallable.big.memory.html | 8 + reference/marshallable.connection.html | 8 + reference/marshallable.data.table.html | 8 + reference/marshallable.html | 34 ++-- reference/marshallable.jclassName.html | 8 + reference/marshallable.jobjRef.html | 8 + ...allable.keras.engine.base_layer.Layer.html | 8 + reference/marshallable.luz_module_fitted.html | 8 + reference/marshallable.magick-image.html | 8 + reference/marshallable.model_fit.html | 8 + reference/marshallable.ncdf4.html | 8 + .../marshallable.python.builtin.object.html | 8 + reference/marshallable.stanfit.html | 8 + reference/marshallable.tbl_spark.html | 8 + reference/marshallable.train.html | 8 + reference/marshallable.udpipe_model.html | 8 + reference/marshallable.xgb.Booster.html | 8 + reference/marshallable.xgb.DMatrix.html | 8 + reference/marshallable.xml_document.html | 8 + reference/marshallable.xml_nodeset.html | 8 + reference/unmarshal.html | 8 + sitemap.xml | 156 +++++------------- 84 files changed, 1094 insertions(+), 906 deletions(-) delete mode 100644 reference/Rplot001.png create mode 100644 reference/assert_no_references.html create mode 100644 reference/marshal.H2OBinomialModel.html create mode 100644 reference/marshal.H2OMultinomialModel.html create mode 100644 reference/marshal.H2ORegressionModel.html create mode 100644 reference/marshal.SOCK0node.html create mode 100644 reference/marshal.SOCKnode.html create mode 100644 reference/marshal.XMLAbstractDocument.html create mode 100644 reference/marshal.jobjRef.html create mode 100644 reference/marshal.xgb.Booster.html create mode 100644 reference/marshal.xml_nodeset.html create mode 100644 reference/marshallable.CFunc.html create mode 100644 reference/marshallable.DBIConnection.html create mode 100644 reference/marshallable.H2OAutoML.html create mode 100644 reference/marshallable.H2OBinomialModel.html create mode 100644 reference/marshallable.H2OMultinomialModel.html create mode 100644 reference/marshallable.H2ORegressionModel.html create mode 100644 reference/marshallable.RasterLayer.html create mode 100644 reference/marshallable.SOCK0node.html create mode 100644 reference/marshallable.SOCKcluster.html create mode 100644 reference/marshallable.SOCKnode.html create mode 100644 reference/marshallable.SpatVector.html create mode 100644 reference/marshallable.XMLAbstractDocument.html create mode 100644 reference/marshallable.XMLAbstractNode.html create mode 100644 reference/marshallable.big.memory.html create mode 100644 reference/marshallable.connection.html create mode 100644 reference/marshallable.data.table.html create mode 100644 reference/marshallable.jclassName.html create mode 100644 reference/marshallable.jobjRef.html create mode 100644 reference/marshallable.keras.engine.base_layer.Layer.html create mode 100644 reference/marshallable.luz_module_fitted.html create mode 100644 reference/marshallable.magick-image.html create mode 100644 reference/marshallable.model_fit.html create mode 100644 reference/marshallable.ncdf4.html create mode 100644 reference/marshallable.python.builtin.object.html create mode 100644 reference/marshallable.stanfit.html create mode 100644 reference/marshallable.tbl_spark.html create mode 100644 reference/marshallable.train.html create mode 100644 reference/marshallable.udpipe_model.html create mode 100644 reference/marshallable.xgb.Booster.html create mode 100644 reference/marshallable.xgb.DMatrix.html create mode 100644 reference/marshallable.xml_document.html create mode 100644 reference/marshallable.xml_nodeset.html create mode 100644 reference/unmarshal.html diff --git a/404.html b/404.html index 7e0bd90..b92192c 100644 --- a/404.html +++ b/404.html @@ -12,7 +12,7 @@ - + @@ -32,7 +32,7 @@ - +
- +
@@ -161,7 +161,7 @@ - +
@@ -189,17 +189,17 @@

Page not found (404)

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Contributing to the ‘marshal’ package • marshal - +
- +
@@ -136,8 +136,8 @@

Contributing to the ‘marshal’ package

-

This Git repository uses the Git Flow branching model (the git flow extension is useful for this). The develop branch contains the latest contributions and other code that will appear in the next release, and the master branch contains the code of the latest release.

-

Contributing to this package is easy. Just send a pull request. When you send your PR, make sure develop is the destination branch on the marshal repository. Your PR should pass R CMD check --as-cran, which will also be checked by GitHub Actions, , and when the PR is submitted.

+

This Git repository uses the Git Flow branching model (the git flow extension is useful for this). The develop branch contains the latest contributions and other code that will appear in the next release, and the master branch contains the code of the latest release.

+

Contributing to this package is easy. Just send a pull request. When you send your PR, make sure develop is the destination branch on the marshal repository. Your PR should pass R CMD check --as-cran, which will also be checked by GitHub Actions and when the PR is submitted.

We abide to the Code of Conduct of Contributor Covenant.

@@ -156,16 +156,16 @@

Contributing to the ‘marshal’ package

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + License • marshal - +
- +
@@ -153,16 +153,16 @@

License

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + MIT License • marshal - +
- +
@@ -157,16 +157,16 @@

MIT License

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Articles • marshal - +
- +
@@ -150,16 +150,16 @@

All vignettes

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + +
+ diff --git a/authors.html b/authors.html index de2d85f..7514833 100644 --- a/authors.html +++ b/authors.html @@ -1,5 +1,5 @@ -Authors and Citation • marshalAuthors and Citation • marshal - +
- +
-

Authors

+

Authors and Citation

- +
  • -

    Henrik Bengtsson. Author, maintainer, copyright holder. +

    Henrik Bengtsson. Author, maintainer, copyright holder.

@@ -151,15 +151,15 @@

Citation

Bengtsson H (2024). marshal: Framework to Marshal Objects to be Used in Another R Process. -R package version 0.0.1-9006, -https://github.com/futureverse/marshal, https://marshal.futureverse.org. +R package version 0.0.1-9006, +https://github.com/futureverse/marshal, https://marshal.futureverse.org. 

@Manual{,
   title = {marshal: Framework to Marshal Objects to be Used in Another R Process},
   author = {Henrik Bengtsson},
   year = {2024},
-  note = {R package version 0.0.1-9006, 
-https://github.com/futureverse/marshal},
+  note = {R package version 0.0.1-9006,
+        https://github.com/futureverse/marshal},
   url = {https://marshal.futureverse.org},
 }
@@ -174,16 +174,16 @@

Citation

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + + @@ -20,7 +20,7 @@ - + @@ -162,103 +162,27 @@ - +
-

marshal: Unified API for Marshalling R Objects +

marshal: Framework to Marshal Objects to be Used in Another R Process

-

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:

-
-file <- system.file("extdata", "r-project.html", package = "xml2")
-doc <- xml2::read_html(file)
-

Next, imagine that we would save this document object doc to file and quit R;

-
-saveRDS(doc, "html.rds")
-quit()
-

Then, if we try to use this saved xml2 object in another R session, we’ll find that it will not work;

-
-doc2 <- readRDS("html.rds")
-xml2::xml_length(doc2)
-#> Error in xml_length.xml_node(doc2) : external pointer is not valid
-

This is because xml2 objects only work in the R process that created them.

-

One solution to this problem is to use “marshalling” to encode the R object into an exportable representation that then can be used to re-create a copy of that object in another R process that imitates the original object.

-

The marshal package provides generic functions marshal() and unmarshal() for marshalling and unmarshalling R objects of certain class. This makes it possible to save otherwise non-exportable objects to file and then be used in a future R session, or to transfer them to another R process to be used there.

-
-
-

Proposed API -

-

The long-term goal with this package is for it to provide a de-facto standard and API for marshalling and unmarshalling objects in R. To achieve this, this package proposes three generic functions:

-
    -

  1. marshallable() - check whether an R object can be marshalled or not

    2. -

  2. marshal() - marshal an R object

    3. -

  3. unmarshal() - reconstruct a marshalled R object

    4. -
-

If we return to our xml2 object, the marshal package implements an S3 marhal() method for different xml2 classes that takes care of everything for us. We can use this when we save the object;

-
-file <- system.file("extdata", "r-project.html", package = "xml2")
-doc <- xml2::read_html(file)
-
-saveRDS(marshal::marshal(doc), "html.rds")
-
-quit()
-

Later, in another R session, we can reconstruct this xml2 HTML document by using:

-
doc2 <- marshal::unmarshal(readRDS("html.rds"))
-xml2::xml_length(doc2)
-[1] 2
-
-
-

Currently supported packages -

-

In order to test the proposed solution and API, this package will implement S3 marshal() methods for some common R packages and their non-exportable classes. Note that the long-term goals is that these S3 methods should be implemented by these packages themselves, such that the marshal package will only provide a light-weight API.

-

The [A Future for R: Non-Exportable Objects] vignette has a collection of packages and classes that cannot be exported out of the box. This package has marshalling prototypes for objects from the following packages:

-
    -
  • caret
    • -
  • data.table
    • -
  • keras
    • -
  • ncdf4
    • -
  • parsnip
    • -
  • raster
    • -
  • rstan
    • -
  • terra
    • -
  • xgboost
    • -
  • XML
    • -
  • xml2
    • -
-

It also has implementations that will throw an error for objects from the following packages, because they cannot be marshalled, at least not at the moment:

-
    -
  • DBI
    • -
  • magick
    • -
  • parallel
    • -
-

The plan is to improve on add support for more R packages and object classes.

-
-

Installation

-

The marshal package is not, yet, on CRAN. In the meanwhile, it can be installed from the R Universe as:

-
-options(repos = c("https://futureverse.r-universe.dev", getOption("repos")))
-install.packages("marshal")
+

R package marshal is only available via GitHub and can be installed in R as:

+
+remotes::install_github("futureverse/marshal", ref="master")

Pre-release version

To install the pre-release version that is available in Git branch develop on GitHub, use:

-
-remotes::install_github("futureverse/marshal", ref = "develop")
+
+remotes::install_github("futureverse/marshal", ref="develop")

This will install the package from source.

@@ -310,8 +234,7 @@

Developers

Dev status

    -
  • R-CMD-check
    • -
  • port4me status badge
    • +
  • R CMD check status
@@ -326,17 +249,17 @@

Dev status

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Changelog • marshal - +
- +
@@ -167,16 +167,16 @@

Significant Changes
-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Get the first or all references of an R object — find_references • marshal
- +
@@ -154,31 +154,29 @@

Get the first or all references of an R object

Arguments

-
x
+ + +
x

The R object to be checked.

-
first_only
+
first_only

If TRUE, only the first reference is returned, otherwise all references.

-
action
+
action

Type of action to take if a reference is found.

-
source
+
source

Is the source of x the globals or the value of the future?

Value

- - -

find_references() returns a list of zero or more references +

find_references() returns a list of zero or more references identified.

- -

If a reference is detected, an informative error, warning, message, or a character string is produced, otherwise NULL is returned invisibly.

@@ -196,16 +194,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Package index • marshal - +
- +
@@ -187,7 +187,7 @@

All functions

Marshalling of 'keras' objects

-

marshal.magick-image marshallable.magick-image

+

marshal(<magick-image>) marshallable(<magick-image>)

Marshalling of 'magick' objects (not supported)

@@ -259,16 +259,16 @@

All functions
-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Package marshal - Marshal Objects to be Used in Another R Process — marshal-package • marshal - +
- +
@@ -165,16 +165,16 @@

Author

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'DBI:DBIConnection' objects (not supported) — marshal.DBIConnection • marshal
- +
@@ -143,28 +143,28 @@

Marshalling of 'DBI:DBIConnection' objects (not supported)

- 
# S3 method for DBIConnection
+    
# S3 method for class 'DBIConnection'
 marshal(x, ...)
 
-# S3 method for DBIConnection
+# S3 method for class 'DBIConnection'
 marshallable(...)

Arguments

-
x
+ + +
x

A DBI::DBIConnection object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -179,16 +179,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'XML' objects — marshal.XMLAbstractNode • marshal - +
- +
@@ -141,35 +141,35 @@

Marshalling of 'XML' objects

- 
# S3 method for XMLAbstractNode
+    
# S3 method for class 'XMLAbstractNode'
 marshal(xml, ...)
 
-# S3 method for XMLAbstractDocument
+# S3 method for class 'XMLAbstractDocument'
 marshal(xml, ...)
 
-# S3 method for XMLAbstractDocument
+# S3 method for class 'XMLAbstractDocument'
 marshallable(...)
 
-# S3 method for XMLAbstractNode
+# S3 method for class 'XMLAbstractNode'
 marshallable(...)

Arguments

-
xml
+ + +
xml

An XML::XMLAbstractNode or XML::XMLAbstractDocument.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -223,16 +223,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'bigmemory' objects — marshal.big.matrix • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'bigmemory' objects

- 
# S3 method for big.matrix
+    
# S3 method for class 'big.matrix'
 marshal(x, ...)
 
-# S3 method for big.memory
+# S3 method for class 'big.memory'
 marshallable(...)

Arguments

-
x
+ + +
x

A bigmemory::big.matrix object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -203,16 +203,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'caret:train' objects — marshal.train • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'caret:train' objects

- 
# S3 method for train
+    
# S3 method for class 'train'
 marshal(train, ...)
 
-# S3 method for train
+# S3 method for class 'train'
 marshallable(...)

Arguments

-
train
+ + +
train

A caret::train object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -184,16 +184,16 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of R connections — marshal.connection • marshal - +
- +
@@ -141,32 +141,32 @@

Marshalling of R connections

- 
# S3 method for connection
+    
# S3 method for class 'connection'
 marshal(con, ...)
 
-# S3 method for connection
+# S3 method for class 'connection'
 marshallable(con, ...)

Arguments

-
con
+ + +
con

A connection.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Limitations

- +

Not all connections can be marshalled, specifically we:

  • cannot marshal connections stdin (0), stdout (1), and stderr (2)

  • can only marshal read-only connections

    • @@ -267,16 +267,16 @@

    Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'data.table' objects — marshal.data.table • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'data.table' objects

- 
# S3 method for data.table
+    
# S3 method for class 'data.table'
 marshal(x, ...)
 
-# S3 method for data.table
+# S3 method for class 'data.table'
 marshallable(...)

Arguments

-
x
+ + +
x

A data.table::data.table object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -202,16 +202,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of an R objects — marshal.default • marshal - +
- +
@@ -141,25 +141,25 @@

Marshalling of an R objects

- 
# S3 method for default
+    
# Default S3 method
 marshal(x, ...)

Arguments

-
x
+ + +
x

An R object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -193,16 +193,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'h2o' objects — marshal.H2OAutoML • marshal - +
- +
@@ -141,46 +141,46 @@

Marshalling of 'h2o' objects

- 
# S3 method for H2OAutoML
+    
# S3 method for class 'H2OAutoML'
 marshal(x, ...)
 
-# S3 method for H2OMultinomialModel
+# S3 method for class 'H2OMultinomialModel'
 marshal(x, ...)
 
-# S3 method for H2OBinomialModel
+# S3 method for class 'H2OBinomialModel'
 marshal(x, ...)
 
-# S3 method for H2ORegressionModel
+# S3 method for class 'H2ORegressionModel'
 marshal(x, ...)
 
-# S3 method for H2OAutoML
+# S3 method for class 'H2OAutoML'
 marshallable(...)
 
-# S3 method for H2OMultinomialModel
+# S3 method for class 'H2OMultinomialModel'
 marshallable(...)
 
-# S3 method for H2OBinomialModel
+# S3 method for class 'H2OBinomialModel'
 marshallable(...)
 
-# S3 method for H2ORegressionModel
+# S3 method for class 'H2ORegressionModel'
 marshallable(...)

Arguments

-
x
+ + +
x

An "h2o" object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -202,16 +202,16 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of R objects — marshal • marshal - +
- +
@@ -148,16 +148,16 @@

Marshalling of R objects

Arguments

-
...
+ + +
...

The object to be marshalled, or unmarshalled, followed by additional arguments passed to the specific S3 method.

Value

- - -

marshal() returns a marshalled object, which is a list with +

marshal() returns a marshalled object, which is a list with components:

  • marshalled: marshalled version of the original object

  • unmarshal: function that takes the marshalled object as input and returns an unmarshalled version of the original object.

    • @@ -176,16 +176,16 @@

    Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'inline' objects — marshal.CFunc • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'inline' objects

- 
# S3 method for CFunc
+    
# S3 method for class 'CFunc'
 marshal(inline, ...)
 
-# S3 method for CFunc
+# S3 method for class 'CFunc'
 marshallable(...)

Arguments

-
inline
+ + +
inline

A CFunc function.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -208,16 +208,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'keras' objects — marshal.keras.engine.base_layer.Layer • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'keras' objects

- 
# S3 method for keras.engine.base_layer.Layer
+    
# S3 method for class 'keras.engine.base_layer.Layer'
 marshal(model, ...)
 
-# S3 method for keras.engine.base_layer.Layer
+# S3 method for class 'keras.engine.base_layer.Layer'
 marshallable(...)

Arguments

-
model
+ + +
model

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

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -235,16 +235,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'magick' objects (not supported) — marshal.magick-image • marshal
- +
@@ -143,28 +143,28 @@

Marshalling of 'magick' objects (not supported)

- 
# S3 method for `magick-image`
+    
# S3 method for class '`magick-image`'
 marshal(x, ...)
 
-# S3 method for `magick-image`
+# S3 method for class '`magick-image`'
 marshallable(...)

Arguments

-
x
-

A magick:magick-image object.

-
...
+
x
+

A magick:magick-image object.

+ + +
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -179,16 +179,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'ncdf4' objects — marshal.ncdf4 • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'ncdf4' objects

- 
# S3 method for ncdf4
+    
# S3 method for class 'ncdf4'
 marshal(x, ...)
 
-# S3 method for ncdf4
+# S3 method for class 'ncdf4'
 marshallable(...)

Arguments

-
x
+ + +
x

A ncdf4:ncdf4 object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -215,16 +215,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'parallel' objects (not supported) — marshal.SOCKcluster • marshal
- +
@@ -143,40 +143,40 @@

Marshalling of 'parallel' objects (not supported)

- 
# S3 method for SOCKcluster
+    
# S3 method for class 'SOCKcluster'
 marshal(x, ...)
 
-# S3 method for SOCKnode
+# S3 method for class 'SOCKnode'
 marshal(x, ...)
 
-# S3 method for SOCK0node
+# S3 method for class 'SOCK0node'
 marshal(x, ...)
 
-# S3 method for SOCKcluster
+# S3 method for class 'SOCKcluster'
 marshallable(...)
 
-# S3 method for SOCKnode
+# S3 method for class 'SOCKnode'
 marshallable(...)
 
-# S3 method for SOCK0node
+# S3 method for class 'SOCK0node'
 marshallable(...)

Arguments

-
x
-

A magick:magick-image object.

-
...
+
x
+

A magick:magick-image object.

+ + +
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -191,16 +191,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'parsnip' objects — marshal.model_fit • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'parsnip' objects

- 
# S3 method for model_fit
+    
# S3 method for class 'model_fit'
 marshal(x, ...)
 
-# S3 method for model_fit
+# S3 method for class 'model_fit'
 marshallable(...)

Arguments

-
x
+ + +
x

A parnsip:model_fit object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -214,16 +214,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'rJava' objects (not supported) — marshal.jclassName • marshal
- +
@@ -143,34 +143,34 @@

Marshalling of 'rJava' objects (not supported)

- 
# S3 method for jclassName
+    
# S3 method for class 'jclassName'
 marshal(x, ...)
 
-# S3 method for jobjRef
+# S3 method for class 'jobjRef'
 marshal(x, ...)
 
-# S3 method for jclassName
+# S3 method for class 'jclassName'
 marshallable(...)
 
-# S3 method for jobjRef
+# S3 method for class 'jobjRef'
 marshallable(...)

Arguments

-
x
+ + +
x

"rJava" object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -185,16 +185,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'raster' objects — marshal.RasterLayer • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'raster' objects

- 
# S3 method for RasterLayer
+    
# S3 method for class 'RasterLayer'
 marshal(x, ...)
 
-# S3 method for RasterLayer
+# S3 method for class 'RasterLayer'
 marshallable(x, ...)

Arguments

-
x
+ + +
x

A raster:RasterLayer object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -173,7 +173,7 @@

Details

WARNING - Numerical identical results cannot be guaranteed

- +

Marshalling of RasterLayer objects is leaky. More precisely, the method cannot guarantee that multiple rounds of marshalling @@ -182,7 +182,7 @@

WARNING - Numerical identical results cannot be guaranteed

References

- +

  1. Issue #311 - 'Incorrect large values saved to disk with writeRaster()', raster GitHub repostory, 2023-05-17, https://github.com/rspatial/raster/issues/311.

    2. @@ -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 : file896b2d46a700.grd +#> source : file12661260d64878.grd #> names : test #> values : 139, 1736 (min, max) #> @@ -233,16 +233,16 @@

    Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'reticulate' objects (not supported) — marshal.python.builtin.object • marshal
- +
@@ -143,28 +143,28 @@

Marshalling of 'reticulate' objects (not supported)

- 
# S3 method for python.builtin.object
+    
# S3 method for class 'python.builtin.object'
 marshal(x, ...)
 
-# S3 method for python.builtin.object
+# S3 method for class 'python.builtin.object'
 marshallable(...)

Arguments

-
x
+ + +
x

"reticulate" object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -179,16 +179,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'rstan' objects — marshal.stanfit • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'rstan' objects

- 
# S3 method for stanfit
+    
# S3 method for class 'stanfit'
 marshal(x, ...)
 
-# S3 method for stanfit
+# S3 method for class 'stanfit'
 marshallable(...)

Arguments

-
x
+ + +
x

A rstan:stanfit object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -177,16 +177,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'sparklyr' objects (not supported) — marshal.tbl_spark • marshal - +
@@ -143,28 +143,28 @@

Marshalling of 'sparklyr' objects (not supported)

- 
# S3 method for tbl_spark
+    
# S3 method for class 'tbl_spark'
 marshal(x, ...)
 
-# S3 method for tbl_spark
+# S3 method for class 'tbl_spark'
 marshallable(...)

Arguments

-
x
+ + +
x

"sparklyr" object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -179,16 +179,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'terra' objects — marshal.SpatVector • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'terra' objects

- 
# S3 method for SpatVector
+    
# S3 method for class 'SpatVector'
 marshal(terra, ...)
 
-# S3 method for SpatVector
+# S3 method for class 'SpatVector'
 marshallable(...)

Arguments

-
terra
+ + +
terra

An terra::SpatVector.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -201,16 +201,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'torch' objects — marshal.luz_module_fitted • marshal - +
- +
@@ -141,28 +141,28 @@

Marshalling of 'torch' objects

- 
# S3 method for luz_module_fitted
+    
# S3 method for class 'luz_module_fitted'
 marshal(model, ...)
 
-# S3 method for luz_module_fitted
+# S3 method for class 'luz_module_fitted'
 marshallable(...)

Arguments

-
model
+ + +
model

A luz_module_fitted object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -184,16 +184,16 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'udpipe' objects (not supported) — marshal.udpipe_model • marshal
- +
@@ -143,28 +143,28 @@

Marshalling of 'udpipe' objects (not supported)

- 
# S3 method for udpipe_model
+    
# S3 method for class 'udpipe_model'
 marshal(x, ...)
 
-# S3 method for udpipe_model
+# S3 method for class 'udpipe_model'
 marshallable(...)

Arguments

-
x
+ + +
x

"udpipe" object.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

@@ -179,16 +179,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'xgboost' objects — marshal.xgb.DMatrix • marshal - +
- +
@@ -141,34 +141,34 @@

Marshalling of 'xgboost' objects

- 
# S3 method for xgb.DMatrix
+    
# S3 method for class 'xgb.DMatrix'
 marshal(x, ...)
 
-# S3 method for xgb.Booster
+# S3 method for class 'xgb.Booster'
 marshal(x, ...)
 
-# S3 method for xgb.Booster
+# S3 method for class 'xgb.Booster'
 marshallable(...)
 
-# S3 method for xgb.DMatrix
+# S3 method for class 'xgb.DMatrix'
 marshallable(...)

Arguments

-
x
+ + +
x

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

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -190,16 +190,16 @@

Details

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Marshalling of 'xml2' objects — marshal.xml_document • marshal - +
- +
@@ -141,34 +141,34 @@

Marshalling of 'xml2' objects

- 
# S3 method for xml_document
+    
# S3 method for class 'xml_document'
 marshal(xml2, ...)
 
-# S3 method for xml_nodeset
+# S3 method for class 'xml_nodeset'
 marshal(xml2, ...)
 
-# S3 method for xml_document
+# S3 method for class 'xml_document'
 marshallable(...)
 
-# S3 method for xml_nodeset
+# S3 method for class 'xml_nodeset'
 marshallable(...)

Arguments

-
xml2
+ + +
xml2

A xml2::xml_document or similar.

-
...
+
...

Not used.

Value

- - -

A marshalled object as described in marshal().

+

A marshalled object as described in marshal().

Details

@@ -205,16 +205,16 @@

Examples

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- + Check if R object can be marshalled — marshallable • marshal - +
- +
@@ -146,16 +146,16 @@

Check if R object can be marshalled

Arguments

-
...
+ + +
...

The object to be checked, followed by additional arguments passed to the specific S3 method.

Value

- - -

TRUE if the object can be marshalled, +

TRUE if the object can be marshalled, FALSE if it cannot be marshalled, and NA if it is not known whether the object can be marshalled.

@@ -172,16 +172,16 @@

Value

-

Site built with pkgdown 2.0.7

and pkgdown.extras 0.0.0.9006.

+

Site built with pkgdown 2.1.1

and pkgdown.extras 0.0.0.9007.

- +