Print methods for metadata records

Print methods for objects of classes used to store different meta data properties in the classes for different types of spectra.

Usage

# S3 method for class 'instr_desc'
print(x, ...)

# S3 method for class 'instr_settings'
print(x, ...)

# S3 method for class 'filter_properties'
print(x, ...)

# S3 method for class 'solute_properties'
print(x, ...)

Arguments

x

An object of one of the summary classes for spectra.

...

not used in current version.

Details

These methods print an abbreviated representaion of objects used to store metadata in attributes. They are similar to records and formatted printing is useful both on its own and in the print methods for spectra and their summaries.

Examples

print(getInstrDesc(sun_evening.spct))
#> Data acquired with 'MayaPro2000' s.n. MAYP112785
#> grating 'HC1', slit '010'
#> diffuser 'cosine'
str(getInstrDesc(sun_evening.spct))
#> List of 6
#>  $ time             : POSIXct[1:1], format: "2017-05-09 17:37:18"
#>  $ spectrometer.name: chr "MayaPro2000"
#>  $ spectrometer.sn  : chr "MAYP112785"
#>  $ bench.grating    : chr "HC1"
#>  $ bench.slit       : chr "010"
#>  $ entrance.optics  :List of 6
#>   ..$ make         : chr "Bentham Instruments"
#>   ..$ model        : chr "D7-H-SMA"
#>   ..$ geometry     : chr "cosine"
#>   ..$ serial.number: chr "12321"
#>   ..$ area         : num 7.85e-05
#>   ..$ fibre        : chr "QP400-2-SR-BX 00S-004728-16"
#>  - attr(*, "class")= chr [1:2] "instr_desc" "list"

print(getInstrSettings(sun_evening.spct))
#> integ. time (s): 0.0383, 0.128, 0.383, 1.28
#> total time (s): 1.03, 1.02, 1.15, 1.28
#> counts @ peak (% of max): 91.4
str(getInstrSettings(sun_evening.spct))
#> List of 16
#>  $ pix.selector   : logi TRUE
#>  $ HDR.mult       : num [1:4] 0.3 1 3 10
#>  $ target.margin  : num 0.1
#>  $ max.integ.time : num 1.6e+09
#>  $ min.integ.time : num 7200
#>  $ tot.time.range : num [1:2] 1e+06 2e+06
#>  $ integ.time     : int [1:4] 38328 127760 383280 1277600
#>  $ num.scans      : num [1:4] 27 8 3 1
#>  $ corr.elect.dark: int 0
#>  $ corr.sensor.nl : int 0
#>  $ boxcar.width   : int 0
#>  $ num.exposures  : int [1:4] -1 -1 -1 -1
#>  $ force.valid    : logi FALSE
#>  $ linearized     : logi TRUE
#>  $ tot.time       : num [1:4] 1034856 1022080 1149840 1277600
#>  $ rel.signal     : num 0.914
#>  - attr(*, "class")= chr [1:2] "instr_settings" "list"

print(filter_properties(polyester.spct))
#> Rfr (/1): 0.074, thickness (mm): 0.125, attenuation mode: absorption.
str(filter_properties(polyester.spct))
#> List of 3
#>  $ Rfr.constant    : num 0.074
#>  $ thickness       : num 0.000125
#>  $ attenuation.mode: chr "absorption"
#>  - attr(*, "class")= chr [1:2] "filter_properties" "list"

print(solute_properties(phenylalanine.spct))
#> Name: phenylalanine, Molar mass (Da): 165.19, Formula: C9H11NO2.
str(solute_properties(phenylalanine.spct))
#> List of 7
#>  $ formula     : Named chr [1:3] "C9H11NO2" "C<sub>9</sub>H<sub>11</sub>NO<sub>2</sub>" "$C_9H_{11}NO_2$"
#>   ..- attr(*, "names")= chr [1:3] "text" "html" "TeX"
#>  $ name        : Named chr [1:2] "phenylalanine" "(2S)-2-amino-3-phenylpropanoic acid"
#>   ..- attr(*, "names")= chr [1:2] "" "IUPAC"
#>  $ structure   : 'raster' chr [1, 1] NA
#>  $ mass        : num 165
#>  $ ID          : Named chr [1:3] "969" "6140" "63-91-2"
#>   ..- attr(*, "names")= chr [1:3] "ChemSpider" "CID" "CAS"
#>  $ solvent.name: Named chr [1:2] "water" "oxidane"
#>   ..- attr(*, "names")= chr [1:2] "" "IUPAC"
#>  $ solvent.ID  : Named chr [1:3] "917" "962" "7732-18-5"
#>   ..- attr(*, "names")= chr [1:3] "ChemSpider" "CID" "CAS"
#>  - attr(*, "class")= chr [1:2] "solute_properties" "list"