second documentation for metadata with roxygen2

NAMESPACE

@@ -1,3 +1,4 @@
 # Generated by roxygen2: do not edit by hand
 
+export(extract.metadata)
 export(read.sig)

R/extract.metadata.R

@@ -1,3 +1,32 @@
+#---------------------------------------------------------------------------------------------------------------------------#
+##' Extract metadata from .sig file
+##' This function reads a file generated by an instrument (default is SVC), extracts metadata, and returns it as a data frame.
+##'
+##' @name extract.metadata
+##' @title read metadata from .sig files
+##'
+##' @param file A character string specifying the path to the file.
+##' @param instrument A character string specifying the type of instrument. Default is "SVC".
+##'
+##' @return A data frame with two columns:
+##' \describe{
+##'   \item{Key}{Character vector representing the metadata keys.}
+##'   \item{Value}{Character vector representing the metadata values.}
+##' }
+##'
+##' @details
+##' The function reads the content of the specified file line by line. It splits each line into key-value pairs based on the "=" delimiter and excludes lines with the key "data". The extracted key-value pairs are stored in a data frame.
+##'
+##' @examples
+##' \dontrun{
+##' metadata <- extract.metadata("/path/to/your/file.sig", instrument = "SVC")
+##' print(metadata)
+##' }
+##'
+##' @author Methun George, Steffen Neumann
+##' @export
+
+
 # function to extract the metadata from SVC
 
 extract.metadata <- function(file, instrument = "SVC") {

R/read.sig.R

@@ -32,7 +32,7 @@
 ##'
 ##'@export
 ##'
-##'@author Methun George
+##'@author Methun George, Steffen Neumann
 ##'
 
 read.sig <- function(file_path) {