Skip to content
Snippets Groups Projects
Verified Commit 1f2cb633 authored by Gärber, Florian's avatar Gärber, Florian
Browse files

fix: Documentation and examples

parent 68d911c7
No related branches found
No related tags found
No related merge requests found
......@@ -293,8 +293,10 @@ simplerspec_to_ChemoSpec <- function(
#' @returns A list of `ChemoSpec::Spectra()` objects.
#'
#' @examples
#' if (FALSE) {
#' data("opusreader2_list")
#' spectra <- opusreader2_to_ChemoSpec(opusreader2_list, "A", 1:3 |> as.character()) |> str()
#' }
#'
#' @export
#' @keywords from_opusreader2 to_ChemoSpec
......
......@@ -6,7 +6,7 @@
\usage{
opusreader2_to_ChemoSpec(
opusreader2_list,
groups = "{missing group}",
groups,
names,
data_block = "ab",
gc = hyperSpec::hy_get_option("gc"),
......@@ -52,8 +52,10 @@ A list of \code{ChemoSpec::Spectra()} objects.
{opusreader2} ⚪ ➡️ 🟠 {ChemoSpec}
}
\examples{
if (FALSE) {
data("opusreader2_list")
spectra <- opusreader2_to_ChemoSpec(opusreader2_list, "A", 1:3 |> as.character()) |> str()
}
}
\seealso{
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/to_hyperSpec.R
\name{to_hyperSpec}
\alias{to_hyperSpec}
\title{*️⃣ {hyperSpec} \\uEFB8\\u8FE2\\u83A3}
\title{*️⃣ {hyperSpec}}
\usage{
to_hyperSpec(...)
}
......@@ -54,6 +54,6 @@ The default value of \code{gc} can be set via \code{\link[hyperSpec:hy_set_optio
A \code{\link[hyperSpec:hyperSpec-class]{hyperSpec::hyperSpec}} object.
}
\description{
*️⃣ {hyperSpec} \\uEFB8\\u8FE2\\u83A3
*️⃣ {hyperSpec}
}
\keyword{to_hyperSpec}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment