Merge pull request #39 from RLumSK/add_conversion_ref2clermont

Add conversion factor reference to clermont dataset for better transparency

NEWS.md

@@ -5,6 +5,7 @@
 * Fix a graphical issue where the peaks were peaks were set with `set_energy()` but did not show correctly when plotted using the standard plot method, e.g., `plot(cal, pks)` would show only observed but not expected energy lines in the secondary x-axis. Now the expected energy lines (if set) are show. (#29, PR #32 by @RLumSK).
 * Add coercion method for `PeakPosition-class` to `list` (exported as `as.list()`) and from `list` to `PeakPosition-class`. This enables better plotting functionality if the peak positions for where provided manually as `list` and not via, e.g., `peak_find()` (PR #37 by @RLumSK).
 * Update vignette about the dose rate calibration curve determination to make it more intelligible (#30 by @RLumSK). 
+* Add conversion factor reference to `clermont` dataset for better transparency.
 
 # gamma 1.0.5
 

R/data.R

@@ -58,7 +58,7 @@ NULL
 #' Clermont Reference Data
 #'
 #' @usage data("clermont")
-#' @format TODO
+#' @format [`data.frame`] with tabulated data and conversion factor reference
 #' @source
 #'  Guérin, G., Mercier, N. & Adamiec, G. (2011). Dose-Rate Conversion Factors:
 #'  Update. *Ancient TL*, 29(1), p. 5-8.

data-raw/clermont.csv

@@ -1,10 +1,10 @@
-name,laboratory,nature,U,U_error,Th,Th_error,K2O,K2O_error,K,K_error,gamma_dose,gamma_error,cosmic_dose,cosmic_error
-BRIQUE,Bordeaux,ceramic,4.10,0.15,13.7,0.40,,,3.50,0.10,1986.462,35.6196793360075,152,6
-C341,Clermont-Ferrand,trachybasalt,1.80,0.05,6.42,0.40,1.65,0.03,,,849.9667515,21.3176152169653,170,15
-C347,Clermont-Ferrand,granite,2.84,0.12,4.67,0.10,4.27,0.10,,,1423.8588757,25.2497557520835,170,15
-GOU,Clermont-Ferrand,trachyandesite,3.18,0.12,11.95,0.06,3.13,0.04,,,1575.2248583,17.4337888551623,110,15
-LAS,Clermont-Ferrand,basalt,2.14,0.04,7.57,0.15,2.33,0.02,,,1083.6737303,9.57059326591591,120,20
-LMP,Clermont-Ferrand,basalt,1.60,0.14,5.91,0.09,0.87,0.03,,,641.9003817,17.5606486719195,120,20
-MAZ,Clermont-Ferrand,trachyandesite,2.39,0.08,8.58,0.04,2.24,0.03,,,1141.4033184,11.6650451785918,200,20
-MPX,Clermont-Ferrand,sandstone,1.38,0.03,3.61,0.20,3.08,0.04,,,964.0195628,13.2741667100568,110,15
-PEP,Clermont-Ferrand,granite,6.00,0.20,19.00,2.00,4.63,0.24,,,2538.2217233,112.169130737782,140,20
+name,laboratory,nature,U,U_error,Th,Th_error,K2O,K2O_error,K,K_error,gamma_dose,gamma_error,cosmic_dose,cosmic_error,ref_conversion_factors
+BRIQUE,Bordeaux,ceramic,4.10,0.15,13.7,0.40,,,3.50,0.10,1986.462,35.6196793360075,152,6,Guérin et al. (2011)
+C341,Clermont-Ferrand,trachybasalt,1.80,0.05,6.42,0.40,1.65,0.03,,,849.9667515,21.3176152169653,170,15,Guérin et al. (2011)
+C347,Clermont-Ferrand,granite,2.84,0.12,4.67,0.10,4.27,0.10,,,1423.8588757,25.2497557520835,170,15,Guérin et al. (2011)
+GOU,Clermont-Ferrand,trachyandesite,3.18,0.12,11.95,0.06,3.13,0.04,,,1575.2248583,17.4337888551623,110,15,Guérin et al. (2011)
+LAS,Clermont-Ferrand,basalt,2.14,0.04,7.57,0.15,2.33,0.02,,,1083.6737303,9.57059326591591,120,20,Guérin et al. (2011)
+LMP,Clermont-Ferrand,basalt,1.60,0.14,5.91,0.09,0.87,0.03,,,641.9003817,17.5606486719195,120,20,Guérin et al. (2011)
+MAZ,Clermont-Ferrand,trachyandesite,2.39,0.08,8.58,0.04,2.24,0.03,,,1141.4033184,11.6650451785918,200,20,Guérin et al. (2011)
+MPX,Clermont-Ferrand,sandstone,1.38,0.03,3.61,0.20,3.08,0.04,,,964.0195628,13.2741667100568,110,15,Guérin et al. (2011)
+PEP,Clermont-Ferrand,granite,6.00,0.20,19.00,2.00,4.63,0.24,,,2538.2217233,112.169130737782,140,20,Guérin et al. (2011)