Skip to content

Commit 55c057c

Browse files
committed
docs: added some more examples
1 parent ca38eea commit 55c057c

10 files changed

+30
-2
lines changed

R/read_agilent_d.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
#' is returned as a \code{matrix}, \code{data.frame} or \code{data.table}.
2525
#' Metadata can be attached to the chromatogram as \code{\link{attributes}} if
2626
#' \code{read_metadata} is \code{TRUE}.
27+
#' @examplesIf interactive()
28+
#' read_agilent_d("tests/testthat/testdata/RUTIN2.D")
2729
#' @author Ethan Bass
2830
#' @family 'Agilent' parsers
2931
#' @export

R/read_chemstation_ch.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
#' \href{https://github.com/chemplexity/chromatography}{Chromatography Toolbox}
3434
#' (&copy James Dillon 2014).
3535
#' @family 'Agilent' parsers
36+
#' @examplesIf interactive()
37+
#' read_chemstation_ch("tests/testthat/testdata/chemstation_130.ch")
3638
#' @export
3739
#' @md
3840

R/read_chemstation_csv.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
#' or \code{data.table}.
1212
#' @return A chromatogram in the format specified by \code{format_out}
1313
#' (retention time x wavelength).
14+
#' @examplesIf interactive()
15+
#' read_chemstation_csv("tests/testthat/testdata/dad1.csv")
1416
#' @author Ethan Bass
1517
#' @family 'Agilent' parsers
1618
#' @export

R/read_chemstation_uv.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
#' \code{format_out} argument determines whether the chromatogram is returned as
2424
#' a \code{matrix} or \code{data.frame}. Metadata can be attached to the
2525
#' chromatogram as \code{\link{attributes}} if \code{read_metadata} is \code{TRUE}.
26+
#' @examplesIf interactive()
27+
#' read_chemstation_uv("tests/testthat/testdata/dad1.uv")
2628
#' @author Ethan Bass
2729
#' @note This function was adapted from the parser in the rainbow project
2830
#' licensed under GPL 3 by Evan Shi

man/read_agilent_d.Rd

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/read_chemstation_ch.Rd

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/read_chemstation_csv.Rd

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/read_chemstation_uv.Rd

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/read_chroms.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/read_peaklist.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)