Import a *.bin or a *.binx file produced by a Risø DA15 and DA20 TL/OSL reader into R.
read_BIN2R(
file,
show.raw.values = FALSE,
position = NULL,
n.records = NULL,
zero_data.rm = TRUE,
duplicated.rm = FALSE,
fastForward = FALSE,
show.record.number = FALSE,
txtProgressBar = TRUE,
forced.VersionNumber = NULL,
ignore.RECTYPE = FALSE,
pattern = NULL,
verbose = TRUE,
...
)
character or list (required): path and file name of the
BIN/BINX file (URLs are supported). If input is a list
it should comprise
only character
s representing each valid path and BIN/BINX-file names.
Alternatively the input character can be just a directory (path), in this case the
the function tries to detect and import all BIN/BINX files found in the directory.
logical (with default):
shows raw values from BIN-file for LTYPE
, DTYPE
and LIGHTSOURCE
without
translation in characters. Can be provided as list
if file
is a list
.
numeric (optional):
imports only the selected position. Note: the import performance will not
benefit by any selection made here.
Can be provided as list
if file
is a list
.
raw (optional):
limits the number of imported records. Can be used in combination with
show.record.number
for debugging purposes, e.g. corrupt BIN-files.
Can be provided as list
if file
is a list
.
logical (with default):
remove erroneous data with no count values. As such data are usually not
needed for the subsequent data analysis they will be removed by default.
Can be provided as list
if file
is a list
.
logical (with default):
remove duplicated entries if TRUE
. This may happen due to an erroneous
produced BIN/BINX-file. This option compares only predecessor and successor.
Can be provided as list
if file
is a list
.
logical (with default):
if TRUE
for a more efficient data processing only a list of RLum.Analysis
objects is returned instead of a Risoe.BINfileData object.
Can be provided as list
if file
is a list
.
logical (with default):
shows record number of the imported record, for debugging usage only.
Can be provided as list
if file
is a list
.
logical (with default): enables or disables txtProgressBar.
integer (optional):
allows to cheat the version number check in the function by own values for
cases where the BIN-file version is not supported.
Can be provided as list
if file
is a list
.
Note: The usage is at own risk, only supported BIN-file versions have been tested.
logical (with default): this argument allows to ignore values in the byte 'RECTYPE' (BIN-file version 08), in case there are not documented or faulty set. In this case the corrupted records are skipped.
character (optional):
argument that is used if only a path is provided. The argument will than be
passed to the function list.files used internally to construct a list
of wanted files
logical (with default): enables or disables verbose mode
further arguments that will be passed to the function
Risoe.BINfileData2RLum.Analysis. Please note that any matching argument
automatically sets fastForward = TRUE
Returns an S4 Risoe.BINfileData object containing two slots:
A data.frame containing all variables stored in the BIN-file.
A list containing a numeric vector of the measured data. The ID corresponds to the record ID in METADATA.
If fastForward = TRUE
a list of RLum.Analysis object is returned. The
internal coercing is done using the function Risoe.BINfileData2RLum.Analysis
The binary data file is parsed byte by byte following the data structure published in the Appendices of the Analyst manual p. 42.
For the general BIN/BINX-file structure, the reader is referred to the Risø website: https://www.fysik.dtu.dk
The function works for BIN/BINX-format versions 03, 04, 05, 06, 07 and 08. The version number depends on the used Sequence Editor.
ROI data sets introduced with BIN-file version 8 are not supported and skipped during import.
0.16.7
Kreutzer, S., Fuchs, M.C., 2023. read_BIN2R(): Import Risø BIN/BINX-files into R. Function version 0.16.7. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., Mercier, N., Philippe, A., Riedesel, S., Autzen, M., Mittelstrass, D., Gray, H.J., Galharret, J., 2023. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.23. https://CRAN.R-project.org/package=Luminescence
DTU Nutech, 2016. The Sequence Editor, Users Manual, February, 2016. https://www.fysik.dtu.dk
file <- system.file("extdata/BINfile_V8.binx", package = "Luminescence")
temp <- read_BIN2R(file)
#>
#> [read_BIN2R()]
#> >> /private/var/folders/yz/3s5p1pss4352wtlzt9_bzbp00000gp/T/RtmpsJE5iq/temp_libpath646e77e64951/Luminescence/extdata/BINfile_V8.binx
#>
|
| | 0%
|
|=================================== | 50%
|
|======================================================================| 100%
#> >> 2 records have been read successfully!
#>
temp
#>
#> [Risoe.BINfileData object]
#>
#> BIN/BINX version 8
#> File name: ExampleData.BINfileData
#> Object date: 060920
#> User: Default
#> System ID: 0 (unknown)
#> Overall records: 2
#> Records type: TL (n = 2)
#> Position range: 1 : 2
#> Grain range: 0 : 0
#> Run range: 1 : 1
#> Set range: 2 : 2