save4qm: Save objects created by qntmap package.

Description Usage Arguments Value save4qm.default save4qm.data.frame save4qm.qm_cluster save4qm.qntmap

View source: R/save.R

Description

Save objects created by qntmap package.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
save4qm(x, nm = "", saving = TRUE, ...)

## Default S3 method:
save4qm(x, nm, saving, ...)

## S3 method for class 'data.frame'
save4qm(x, nm, saving, ...)

## S3 method for class 'qm_cluster'
save4qm(x, nm, saving, dir_out = ".", suffix = "_.*", elements = "", ...)

## S3 method for class 'qntmap'
save4qm(x, nm, saving, ...)

Arguments

x

An object to save.

nm

A name of object to be saved as.

saving

TRUE (default) or FALSE to save.

...

Other arguments passed to class methods

dir_out

output directory

suffix

A regular expression of suffix of cluster names. Clusters with the same prefix comprise a super cluster. For example, "Pl_NaRich" and "Pl_NaPoor" becomes "Pl" cluster if suffix = "_.*" (default).

elements

A character vector to chose elements to be utilized in cluster analysis. NULL (default) selects as much elements as possible.

Value

invisible(x)

save4qm.default

A default method saves an object as a binary RDS file.

save4qm.data.frame

A data frame object is saved as a csv.

save4qm.qm_cluster

A value returned by cluster_xmap() or group_cluster() is saved as binary RDS file, dot-by-dot png file, and as svg file with a legend. The png and svg files show distribution of phases among a mapped area.

save4qm.qntmap

A value returned by qntmap() or quantify() is saved as a binary RDS file, and csv files.


atusy/qntmap documentation built on Dec. 3, 2019, 12:11 p.m.