-
Notifications
You must be signed in to change notification settings - Fork 8
/
analyse_ThermochronometryData.Rd
53 lines (47 loc) · 1.25 KB
/
analyse_ThermochronometryData.Rd
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/analyse_ThermochronometryData.R
\name{analyse_ThermochronometryData}
\alias{analyse_ThermochronometryData}
\title{Analyse Thermochronometry Data}
\usage{
analyse_ThermochronometryData(
object,
ITL_model = c("GOK", "BTS"),
plot = TRUE,
verbose = TRUE,
...
)
}
\arguments{
\item{object}{\link{character} (\strong{required}): path to a CSV file ##TODO;
alternatively a \link{vector} of paths}
\item{ITL_model}{\link{character} (\emph{with default}): type of model to fit,
either \code{"GOK"} (default) or \code{"BTS"}}
\item{plot}{\link{logical} (\emph{with default}): enable/disable plot output}
\item{verbose}{\link{logical} (\emph{with default}): enable/disable terminal output}
\item{...}{currently unused}
}
\value{
An \linkS4class{RLum.Results} object is returned: ##TODO
}
\description{
Analyse thermochronometry data based on MatLab code written
by XXX and XXX and XXX
}
\details{
##TODO
}
\section{Function version}{
0.1.0
}
\examples{
# example code ##TODO
}
\seealso{
\link{analyse_FadingMeasurement}, \link{fit_IsothermalHolding}
}
\author{
Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany),
Svenja Riedesel, DTU Risø (Denmark)
}
\keyword{datagen}