From a56f24f5a0a5f34d5c599fd4ba95ec8bceb21ac2 Mon Sep 17 00:00:00 2001 From: atusy <30277794+atusy@users.noreply.github.com> Date: Tue, 4 Sep 2018 09:37:39 +0900 Subject: [PATCH] doc by pkgdown::build_site --- docs/LICENSE-text.html | 3 + docs/authors.html | 3 + docs/index.html | 50 +++-- docs/news/index.html | 250 +++++++++++++++++++++++++ docs/reference/cluster.html | 15 +- docs/reference/cluster_xmap.html | 23 ++- docs/reference/find_centers.html | 30 ++- docs/reference/find_centers_kpp.html | 5 +- docs/reference/group_cluster.html | 13 +- docs/reference/index.html | 43 ++++- docs/reference/print.qntmap.html | 17 +- docs/reference/qltmap_cls_centers.html | 174 +++++++++++++++++ docs/reference/qltmap_load.html | 168 +++++++++++++++++ docs/reference/qntmap.html | 3 + docs/reference/qntmap_cls_pois.html | 173 +++++++++++++++++ docs/reference/qntmap_quantify.html | 179 ++++++++++++++++++ docs/reference/quantify.html | 20 +- docs/reference/read_cnd.html | 5 +- docs/reference/read_qnt.html | 7 +- docs/reference/read_xmap.html | 17 +- docs/reference/save4qm.html | 37 ++-- docs/reference/summary_methods.html | 163 ++++++++++++++++ docs/reference/tidy_epma.html | 3 + man/save4qm.Rd | 2 +- 24 files changed, 1290 insertions(+), 113 deletions(-) create mode 100644 docs/news/index.html create mode 100644 docs/reference/qltmap_cls_centers.html create mode 100644 docs/reference/qltmap_load.html create mode 100644 docs/reference/qntmap_cls_pois.html create mode 100644 docs/reference/qntmap_quantify.html create mode 100644 docs/reference/summary_methods.html diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 8179c4e..b42cfaa 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -72,6 +72,9 @@
  • Reference +
    • +
  • + Changelog
    • diff --git a/docs/authors.html b/docs/authors.html index eb8ef61..00061ff 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -72,6 +72,9 @@
  • Reference +
    • +
  • + Changelog
    • diff --git a/docs/index.html b/docs/index.html index b200f7a..13cd955 100644 --- a/docs/index.html +++ b/docs/index.html @@ -45,6 +45,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -97,14 +100,14 @@
    -

    Poisson distribution based custering based on `PoiClaClu:Classify()`

    +

    Poisson distribution based custering based on PoiClaClu:Classify()

    Source: R/cluster.R
    -

    Poisson distribution based custering based on `PoiClaClu:Classify()`

    +

    Poisson distribution based custering based on PoiClaClu:Classify()

    @@ -120,7 +123,7 @@

    Arg centers -

    c-by-p matrix returned by `find_centers()` or by manually; c clusters and p features. Used to guess initial centers (or centroids) of clusters. A value returned by , typically `data.frame` or `matrix`, indicating initial guess centers (or centroids) or clusters. See `find_centers()`.

    +

    c-by-p matrix returned by find_centers() or by manually; c clusters and p features. Used to guess initial centers (or centroids) of clusters. A value returned by , typically data.frame or matrix, indicating initial guess centers (or centroids) or clusters. See find_centers().

    xte diff --git a/docs/reference/cluster_xmap.html b/docs/reference/cluster_xmap.html index 4d2cc62..2a73929 100644 --- a/docs/reference/cluster_xmap.html +++ b/docs/reference/cluster_xmap.html @@ -6,7 +6,7 @@ -cluster mapping data into mineral species — cluster_xmap • qntmap +Cluster mapping data into mineral species — cluster_xmap • qntmap @@ -30,9 +30,9 @@ - + - + @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -97,14 +100,14 @@
    -

    cluster mapping data into mineral species

    +

    Cluster mapping data into mineral species

    Source: R/cluster.R
    -

    cluster mapping data into mineral species

    +

    Cluster mapping data into mineral species

    @@ -116,23 +119,23 @@

    Arg xmap -

    a `qm_xmap`` class object

    +

    a qm_xmap class object returned by read_xmap

    centers -

    c-by-p matrix returned by `find_centers()` or by manually; c clusters and p features. Used to guess initial centers (or centroids) of clusters. A value returned by , typically `data.frame` or `matrix`, indicating initial guess centers (or centroids) or clusters. See `find_centers()`.

    +

    c-by-p matrix returned by find_centers() or by manually; c clusters and p features. Used to guess initial centers (or centroids) of clusters. A value returned by , typically data.frame or matrix, indicating initial guess centers (or centroids) or clusters. See find_centers().

    elements -

    A character vector indicating which elements to be utilized in cluster analysis. `NULL`, in default, selects as much elements as possible are utilized in cluster analysis.

    +

    A character vector indicating which elements to be utilized in cluster analysis. NULL, in default, selects as much elements as possible are utilized in cluster analysis.

    saving -

    `TRUE` or `FALSE` to save result.

    +

    TRUE or FALSE to save result.

    group_cluster -

    `TRUE` or `FALSE` to integrate same phase with obiously different compositions. For example, when there are clusters named as Pl_NaRich and Pl_NaPoor, they are grouped as Pl.

    +

    TRUE (default) or FALSE to integrate same phase subgrouped using suffix. For example, when there are clusters named as Pl_NaRich and Pl_NaPoor, they are grouped as Pl.

    diff --git a/docs/reference/find_centers.html b/docs/reference/find_centers.html index e683849..d79df2c 100644 --- a/docs/reference/find_centers.html +++ b/docs/reference/find_centers.html @@ -6,7 +6,7 @@ -Initialize centroids for `cluster_xmap()` — find_centers • qntmap +Initialize centroids for <code>cluster_xmap()</code> — find_centers • qntmap @@ -30,9 +30,9 @@ - + - + @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -97,32 +100,29 @@
    -

    Initialize centroids for `cluster_xmap()`

    +

    Initialize centroids for cluster_xmap()

    Source: R/find_centers.R
    -

    Initialize centroids for `cluster_xmap()`

    +

    Initialize centroids for cluster_xmap()

    - 
    find_centers(xmap, qnt, fine_phase = NULL, saveas = "centers0.csv")
-
-qltmap_cls_centers(wd = ".", dir_map = ".", xmap, qnt,
-  fine_phase = NULL, saveas = "centers0.csv")
    + 
    find_centers(xmap, qnt, fine_phase = NULL, saveas = "centers0.csv")

    Arguments

    - + - + @@ -132,14 +132,6 @@

    Arg

    - - - - - - - -
    xmap

    an `qm_xmap` class object generated by `read_xmap()``

    an qm_xmap class object generated by `read_xmap()``
    qnt

    an `qm_qnt` class object generated by `read_qnt()``

    an qm_qnt class object generated by `read_qnt()``
    fine_phasesaveas

    File name to save result. FALSE if not saving.
    wd

    working directory which contains .qnt directory. Use current directory if NULL

    dir_map

    ignored

    diff --git a/docs/reference/find_centers_kpp.html b/docs/reference/find_centers_kpp.html index 4227646..04b26c2 100644 --- a/docs/reference/find_centers_kpp.html +++ b/docs/reference/find_centers_kpp.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -115,7 +118,7 @@

    Arg x -

    An object which can be coerced to `matrix`, typically `matrix` itself or `data.frame`.

    +

    An object which can be coerced to matrix, typically matrix itself or data.frame.

    k diff --git a/docs/reference/group_cluster.html b/docs/reference/group_cluster.html index bc74085..1b24fd1 100644 --- a/docs/reference/group_cluster.html +++ b/docs/reference/group_cluster.html @@ -32,7 +32,7 @@ - @@ -76,6 +76,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -105,7 +108,7 @@

    group clusters who share same prefix

    -

    When data points are assigned to clusters A_1 and A_2, +

    When data points are assigned to clusters A_1 and A_2, their clusters are renamed to be A by matching regular expressions.

    @@ -117,15 +120,15 @@

    Arg x -

    `qm_cluster` class object returned by `qltmap_cls_pois()`.

    +

    qm_cluster class object returned by qltmap_cls_pois().

    saving -

    `TRUE` or `FALSE` to save result (default: `TRUE`).

    +

    TRUE or FALSE to save result (default: TRUE).

    suffix -

    A regular expression of suffix (default: `'_.*'`)

    +

    A regular expression of suffix (default: '_.*')

    diff --git a/docs/reference/index.html b/docs/reference/index.html index 87df7f6..a329586 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -72,6 +72,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -117,19 +120,19 @@

    cluster()

    -

    Poisson distribution based custering based on `PoiClaClu:Classify()`

    +

    Poisson distribution based custering based on PoiClaClu:Classify()

    cluster_xmap()

    -

    cluster mapping data into mineral species

    +

    Cluster mapping data into mineral species

    -

    find_centers() qltmap_cls_centers()

    +

    find_centers()

    -

    Initialize centroids for `cluster_xmap()`

    +

    Initialize centroids for cluster_xmap()

    @@ -147,7 +150,19 @@

    print(<qntmap>)

    -

    `print` method for `qntmap` class object

    +

    print method for qntmap class object

    + + + +

    qltmap_cls_centers()

    + +

    (Deprecated) Use find_centers

    + + + +

    qltmap_load()

    + +

    (DEPRECATED) Use read_xmap

    @@ -157,7 +172,19 @@

    quantify() qntmap_quantify()

    +

    qntmap_cls_pois()

    + +

    (Deprecated) Use cluster_xmap()

    + + + +

    qntmap_quantify()

    + +

    (Deprecated) Use quantify.

    + + + +

    quantify()

    quantify qualtitative mapping data

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

    read_xmap() qltmap_load()

    +

    read_xmap()

    read X-ray map data

    @@ -187,7 +214,7 @@

    summary(<qm_cluster>)

    +

    summary(<qm_cluster>)

    summary methods

    diff --git a/docs/reference/print.qntmap.html b/docs/reference/print.qntmap.html index 4e1ba42..114da2b 100644 --- a/docs/reference/print.qntmap.html +++ b/docs/reference/print.qntmap.html @@ -6,7 +6,7 @@ -`print` method for `qntmap` class object — print.qntmap • qntmap +<code>print</code> method for <code>qntmap</code> class object — print.qntmap • qntmap @@ -30,9 +30,9 @@ - + - + @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -97,14 +100,14 @@
    -

    `print` method for `qntmap` class object

    +

    print method for qntmap class object

    Source: R/print.R
    -

    `print` method for `qntmap` class object

    +

    print method for qntmap class object

    @@ -116,11 +119,11 @@

    Arg x -

    `qntmap` class object returned by `quantify()` or `qntmap()`.

    +

    qntmap class object returned by quantify() or qntmap().

    summarizing -

    `TRUE` or `FALSE` to summarize x (default: `TRUE`.

    +

    TRUE or FALSE to summarize x (default: TRUE.

    ... diff --git a/docs/reference/qltmap_cls_centers.html b/docs/reference/qltmap_cls_centers.html new file mode 100644 index 0000000..d1bed2f --- /dev/null +++ b/docs/reference/qltmap_cls_centers.html @@ -0,0 +1,174 @@ + + + + + + + + +(Deprecated) Use find_centers — qltmap_cls_centers • qntmap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    (Deprecated) Use find_centers

    + Source: R/find_centers.R + +
    + +
    + +

    (Deprecated) Use find_centers

    + +
    + + 
    qltmap_cls_centers(wd = NULL, dir_map, phase_fine = NULL,
+  qnt = read_qnt(paste0(wd, "/.qnt")), qltmap = read_xmap(dir_map),
+  saving = "centers_initial0.csv")
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    wd

    working directory which contains .qnt directory. Use current directory if NULL

    dir_map

    path to the directory which contains mapping data.

    phase_fine

    fine grained phases which tend to be appear in multi-phase pixels e.g., c('Pl', 'Amp')

    qnt

    an object generated by qnt_load or a path to the .RDS file created by qnt_load

    qltmap

    an object generated by qltmap_load or a path to the .RDS file created by qltmap_load

    saving

    file name to save. FALSE if not saving.

    + + +
    + +
    + +
    +
    +

    Developed by Atsushi YASUMOTO.

    +
    + +
    +

    Site built with pkgdown.

    +
    + +
    +
    + + + + + + diff --git a/docs/reference/qltmap_load.html b/docs/reference/qltmap_load.html new file mode 100644 index 0000000..3f1fedb --- /dev/null +++ b/docs/reference/qltmap_load.html @@ -0,0 +1,168 @@ + + + + + + + + +(DEPRECATED) Use read_xmap — qltmap_load • qntmap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    (DEPRECATED) Use read_xmap

    + Source: R/read_xmap.R + +
    + +
    + +

    (DEPRECATED) Use read_xmap

    + +
    + + 
    qltmap_load(wd = ".", DT = 0, RDS, renew = FALSE, saving = TRUE)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + +
    wd

    directory path containing mapping data (e.g., ./.map/.1)

    DT

    dead time in nano seconds (0 nsec in default)

    RDS

    ignored.

    renew

    if TRUE and the file specified by RDS exists, that file will be loaded

    saving

    whether or not to save the data as RDS file

    + + +
    + +
    + +
    +
    +

    Developed by Atsushi YASUMOTO.

    +
    + +
    +

    Site built with pkgdown.

    +
    + +
    +
    + + + + + + diff --git a/docs/reference/qntmap.html b/docs/reference/qntmap.html index 922ac6b..d7b89c2 100644 --- a/docs/reference/qntmap.html +++ b/docs/reference/qntmap.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • diff --git a/docs/reference/qntmap_cls_pois.html b/docs/reference/qntmap_cls_pois.html new file mode 100644 index 0000000..6f33f77 --- /dev/null +++ b/docs/reference/qntmap_cls_pois.html @@ -0,0 +1,173 @@ + + + + + + + + +(Deprecated) Use <code>cluster_xmap()</code> — qntmap_cls_pois • qntmap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    (Deprecated) Use cluster_xmap()

    + Source: R/cluster.R + +
    + +
    + +

    (Deprecated) Use cluster_xmap()

    + +
    + + 
    qntmap_cls_pois(centers_initial, qltmap = NULL, elements = NULL,
+  wd = ".", saving = TRUE, integration = TRUE)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    centers_initial

    Equivalent to centers_initial parameter of cluster_xmap

    qltmap

    Equivalent to xmap parameter of cluster_xmap

    elements

    A character vector indicating which elements to be utilized in cluster analysis. NULL, in default, selects as much elements as possible are utilized in cluster analysis.

    wd

    Path to the working directory.

    saving

    TRUE or FALSE to save result.

    integration

    Equivalent to group_cluster parameter of cluster_xmap

    + + +
    + +
    + +
    +
    +

    Developed by Atsushi YASUMOTO.

    +
    + +
    +

    Site built with pkgdown.

    +
    + +
    +
    + + + + + + diff --git a/docs/reference/qntmap_quantify.html b/docs/reference/qntmap_quantify.html new file mode 100644 index 0000000..30ff488 --- /dev/null +++ b/docs/reference/qntmap_quantify.html @@ -0,0 +1,179 @@ + + + + + + + + +(Deprecated) Use quantify. — qntmap_quantify • qntmap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    (Deprecated) Use quantify.

    + Source: R/quantify.R + +
    + +
    + +

    (Deprecated) Use quantify.

    + +
    + + 
    qntmap_quantify(wd = ".", dir_map, RDS_cluster, maps_x = NULL,
+  maps_y = NULL, fine_phase = NULL, fine_th = 0.9,
+  qnt = qnt_load(wd), qltmap = qltmap_load(dir_map),
+  cluster = readRDS(RDS_cluster))
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    wd

    working directory which contains .qnt and .map directories

    maps_x

    A x-axis size of maps comprising guide net map (default: NULL).

    maps_y

    A y-axis size of maps comprising guide net map (default: NULL).

    fine_phase

    A character vector to specify fine grained phases which tend to comprise multi-phase pixels e.g., c('Pl', 'Amp')

    fine_th

    0.9

    qnt

    qm_qnt class object returned by read_qnt().

    cluster

    qm_cluster class object returned by cluter_xmap().

    + + +
    + +
    + +
    +
    +

    Developed by Atsushi YASUMOTO.

    +
    + +
    +

    Site built with pkgdown.

    +
    + +
    +
    + + + + + + diff --git a/docs/reference/quantify.html b/docs/reference/quantify.html index b7c320e..e007bef 100644 --- a/docs/reference/quantify.html +++ b/docs/reference/quantify.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -109,9 +112,6 @@

    quantify qualtitative mapping data

    quantify(xmap, qnt, cluster, maps_x = NULL, maps_y = NULL,
-  fine_phase = NULL, fine_th = 0.9, fixAB = NULL, fixB = NULL)
-
-qntmap_quantify(xmap, qnt, cluster, maps_x = NULL, maps_y = NULL,
   fine_phase = NULL, fine_th = 0.9, fixAB = NULL, fixB = NULL)

    Arguments

    @@ -119,23 +119,23 @@

    Arg xmap -

    `qm_xmap` class object returned by `read_xmap()`.

    +

    qm_xmap class object returned by read_xmap().

    qnt -

    `qm_qnt` class object returned by `read_qnt()`.

    +

    qm_qnt class object returned by read_qnt().

    cluster -

    `qm_cluster` class object returned by `cluter_xmap()`.

    +

    qm_cluster class object returned by cluter_xmap().

    maps_x -

    A x-axis size of maps comprising guide net map (default: `NULL`).

    +

    A x-axis size of maps comprising guide net map (default: NULL).

    maps_y -

    A y-axis size of maps comprising guide net map (default: `NULL`).

    +

    A y-axis size of maps comprising guide net map (default: NULL).

    fine_phase @@ -147,11 +147,11 @@

    Arg fixAB -

    fix AB in case compositions of a mineral is constant (default: `NULL`).

    +

    fix AB in case compositions of a mineral is constant (default: NULL).

    fixB -

    fix B (default: `NULL`).

    +

    fix B (default: NULL).

    diff --git a/docs/reference/read_cnd.html b/docs/reference/read_cnd.html index f2d2d7a..83c62e0 100644 --- a/docs/reference/read_cnd.html +++ b/docs/reference/read_cnd.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -129,7 +132,7 @@

    Arg

    .default

    -

    A default method which returns a result of `readLines(x)` +

    A default method which returns a result of readLines(x) with additional class according to the content of the file.

    diff --git a/docs/reference/read_qnt.html b/docs/reference/read_qnt.html index 2098f75..9e21609 100644 --- a/docs/reference/read_qnt.html +++ b/docs/reference/read_qnt.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -111,8 +114,8 @@

    compile quantitative data

    read_qnt(wd = dir(pattern = ("(.*_QNT|^\\.qnt)$"), all.files =
   TRUE)[1], phase_list = NULL, renew = FALSE, saving = TRUE)
 
-qnt_load(wd = NULL, RDS = "qnt.RDS", phase_list = NULL,
-  renew = FALSE, saving = TRUE)
    +qnt_load(wd = NULL, RDS, phase_list = NULL, renew = FALSE, + saving = TRUE)

    Arguments

    diff --git a/docs/reference/read_xmap.html b/docs/reference/read_xmap.html index e092707..2f67d57 100644 --- a/docs/reference/read_xmap.html +++ b/docs/reference/read_xmap.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -110,10 +113,6 @@

    read X-ray map data

    read_xmap(wd = ".map/1", DT = 0, renew = FALSE, saving = TRUE,
   .map = "(data)?[0-9]*[1-9](\\.csv|_map\\.txt)",
-  .cnd = "(data)?[0-9]*[1-9]\\.cnd")
-
-qltmap_load(wd = ".map/1", DT = 0, renew = FALSE, saving = TRUE,
-  .map = "(data)?[0-9]*[1-9](\\.csv|_map\\.txt)",
   .cnd = "(data)?[0-9]*[1-9]\\.cnd")

    Arguments

    @@ -137,23 +136,17 @@

    Arg

    - +
    .map, .cnd

    regular expressions to match ASCII converted mapping results (`.map`) and condition files (`.cnd`)

    regular expressions to match ASCII converted mapping results (.map) and condition files (.cnd)
    -

    `qltmap_load`

    - -

    DEPRECATED!! use read_xmap

    -

    diff --git a/docs/reference/save4qm.html b/docs/reference/save4qm.html index 785a881..ba6eb5d 100644 --- a/docs/reference/save4qm.html +++ b/docs/reference/save4qm.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • @@ -135,7 +138,7 @@

    Arg saving -

    whether or not to save

    +

    TRUE or FALSE to save result file(s).

    ... @@ -143,38 +146,38 @@

    Arg dir_qntmap -

    A path to the directory to save `x`.

    +

    A path to the directory to save x.

    Value

    -

    `invisible(x)`

    +

    invisible(x)

    -

    `save4qm.default`

    +

    save4qm.default

    A default method. -This is a wrapper of `saveRDS` together with invisible return of `x`.

    +This is a wrapper of saveRDS together with invisible return of x.

    -

    `save4qm.data.frame`

    +

    save4qm.data.frame

    -

    A method for `data.frame` class. -This is a wrapper of `data.table::fwrite` -together with invisible return of `x`.

    +

    A method for data.frame class. +This is a wrapper of data.table::fwrite +together with invisible return of x.

    -

    `save4qm.qm_cluster`

    +

    save4qm.qm_cluster

    -

    A method for `qm_cluster` class returned by `cluster_xmap()` or `cluster_group()`. +

    A method for qm_cluster class returned by cluster_xmap() or cluster_group(). Object is saved as RDS file and png file. The latter shows distribution of phases among a mapped area.

    -

    `save4qm.qntmap`

    +

    save4qm.qntmap

    -

    A method for `qntmap` class returned by `qntmap()` or `quantify()`

    +

    A method for qntmap class returned by qntmap() or quantify()

    @@ -185,13 +188,13 @@

    Contents

  • Value
    • -
  • `save4qm.default`
    • +
  • save4qm.default
    • -
  • `save4qm.data.frame`
    • +
  • save4qm.data.frame
    • -
  • `save4qm.qm_cluster`
    • +
  • save4qm.qm_cluster
    • -
  • `save4qm.qntmap`
    • +
  • save4qm.qntmap
    • diff --git a/docs/reference/summary_methods.html b/docs/reference/summary_methods.html new file mode 100644 index 0000000..c365c69 --- /dev/null +++ b/docs/reference/summary_methods.html @@ -0,0 +1,163 @@ + + + + + + + + +summary methods — summary_methods • qntmap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    summary methods

    + Source: R/summary.R + +
    + +
    + +

    summary methods

    + +
    + + 
    # S3 method for qm_cluster
+summary(object, ...)
    + +

    Arguments

    + + + + + + + + + + +
    object

    object to be summarized

    ...

    other arguments to control summary results

    + +

    summary.qm_cluster

    + +

    Returns abundance ratios of clusters.

    + + +
    + +
    + +
    +
    +

    Developed by Atsushi YASUMOTO.

    +
    + +
    +

    Site built with pkgdown.

    +
    + +
    +
    + + + + + + diff --git a/docs/reference/tidy_epma.html b/docs/reference/tidy_epma.html index 41b9875..811a1f7 100644 --- a/docs/reference/tidy_epma.html +++ b/docs/reference/tidy_epma.html @@ -75,6 +75,9 @@
  • Reference +
    • +
  • + Changelog
    • diff --git a/man/save4qm.Rd b/man/save4qm.Rd index b212e6d..883f625 100644 --- a/man/save4qm.Rd +++ b/man/save4qm.Rd @@ -8,7 +8,7 @@ \alias{save4qm.qntmap} \title{S3 generics to save returned values from functions in QntMap package.} \usage{ -save4qm(x, nm, saving = TRUE, ...) +save4qm(x, nm = "", saving = TRUE, ...) \method{save4qm}{default}(x, nm, saving, ...)