summarise_mineralogy: Summarise the mineralogy from multiple powdRfps and powdRafps...

Description Usage Arguments Value Examples

View source: R/summarise_mineralogy.R

Description

summarise_mineralogy creates a summary table of quantified mineral concentrations across a given dataset using a list of multiple powdRfps or powdRafps derived from fps() and afps(), respectively.

Usage

1

Arguments

x

a list of powdRfps or powdRafps objects.

type

a string specifying whether the table uses all phase ID's, or summarises them according to the phase name. One of "all" or "grouped".

order

a logical operator denoting whether the columns of the resulting summary table are ordered in descending order according to the summed abundance of each phase across the dataset.

rwp

a logical operator denoting whether to include the Rwp as the final column in the output. This provides an objective measure of the difference between the fitted and measured patterns.

Value

a dataframe

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
data(minerals)
data(soils)

## Not run: 
multiple_afps <- lapply(soils, afps,
                        lib = minerals,
                        std = "QUA.1",
                        align = 0.2,
                        lod = 0.1,
                        amorphous = "ORG",
                        amorphous_lod = 1)

sm1 <- summarise_mineralogy(multiple_afps,
                            type = "all",
                            order = TRUE)

sm2 <- summarise_mineralogy(multiple_afps,
                            type = "grouped",
                            order = TRUE)

sm3 <- summarise_mineralogy(multiple_afps,
                            type = "grouped",
                            order = TRUE,
                            rwp = TRUE)

## End(Not run)

benmbutler/powdR documentation built on Sept. 16, 2020, 5:03 a.m.