Update @return statement

... with link to `hyperSpec` object.
Closes #68

R/read_asc_PerkinElmer.R

@@ -9,7 +9,9 @@
 #' @param file Path  or connection to file.
 #' @param ... Further argument handed to [hyperSpec::read_txt_long()].
 #'
-#' @return `hyperSpec` object.
+#'
+#' @return [hyperSpec][hyperSpec::hyperSpec-class()] object.
+#'
 #'
 #' @concept io
 #'

R/read_txt_Horiba.R

@@ -17,7 +17,9 @@
 #' @param cols,header,sep,row.names,check.names,... further parameters are
 #'        handed over to [hyperSpec::read_txt_wide()]
 #'
-#' @return `hyperSpec` object.
+#'
+#' @return [hyperSpec][hyperSpec::hyperSpec-class()] object.
+#'
 #'
 #' @author C. Beleites
 #'

R/read_txt_PerkinElmer.R

@@ -6,7 +6,9 @@
 #' @param ... Passed to [base::scan()].
 #' @param label Labels.
 #'
-#' @return `hyperSpec` object.
+#'
+#' @return [hyperSpec][hyperSpec::hyperSpec-class()] object.
+#'
 #'
 #' @importFrom utils modifyList
 #' @export

R/read_txt_Renishaw.R

@@ -38,7 +38,7 @@
 #' @param nspc number of spectra in the file
 #' @param ... Arguments for `read_txt_Renishaw`
 #'
-#' @return  `hyperSpec` object.
+#' @return [hyperSpec][hyperSpec::hyperSpec-class()] object.
 #'
 #'
 #' @author C. Beleites

R/read_txt_WITec_.R

@@ -23,7 +23,9 @@
 #' @param encoding character encoding, see [base::readLines()].
 #' @param ...,quiet handed to [base::scan()].
 #'
-#' @return `hyperSpec` object.
+#'
+#' @return [hyperSpec][hyperSpec::hyperSpec-class()] object.
+#'
 #'
 #' @author Claudia Beleites and Marcel Dahms
 #'

vignettes/read_txt_PerkinElmer.R

@@ -1,4 +1,4 @@
-@@ -0,0 +1,67 @@
+
 # Function -------------------------------------------------------------------
 
 #' Read PerkinElmer file (ASCII/txt)
@@ -7,7 +7,9 @@
 #' @param ... Passed to [base::scan()].
 #' @param label Labels.
 #'
-#' @return `hyperSpec` object.
+#'
+#' @return [hyperSpec][hyperSpec::hyperSpec-class()] object.
+#'
 #'
 #' @export
 #'