diff --git a/man/CadenzaAnalytics-package.Rd b/man/CadenzaAnalytics-package.Rd index 20a0e8a..50fb21c 100644 --- a/man/CadenzaAnalytics-package.Rd +++ b/man/CadenzaAnalytics-package.Rd @@ -3,12 +3,28 @@ % R/plumbercadenza-package.R \docType{package} \name{CadenzaAnalytics-package} +\alias{CadenzaAnalytics} \alias{CadenzaAnalytics-package} \title{CadenzaAnalytics: Create An API For The Cadenza Analytics Extension With Plumber} \description{ Cadenza Analytics Extensions enable complex data analytics to be integrated via external services. This package provides the tooling to create such Analytics Extensions easily from R. Cadenza Analytics Extensions enable complex data analytics to be integrated via external services. This package provides the tooling to create such Analytics Extensions easily from R. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://disyinformationssysteme.github.io/cadenza-analytics-r/} + \item \url{https://github.com/DisyInformationssysteme/cadenza-analytics-r} +} + + +Useful links: +\itemize{ + \item \url{https://disyinformationssysteme.github.io/cadenza-analytics-r/} + \item \url{https://github.com/DisyInformationssysteme/cadenza-analytics-r} +} + } \author{ \strong{Maintainer}: Matthias Theobald \email{matthias.theobald@disy.net} @@ -17,7 +33,7 @@ Authors: \itemize{ \item Lossow Stefan \email{stefan.lossow@disy.net} \item Herrmann Marius \email{marius.herrmann@disy.net} - \item Babenhauserheide Arne \email{arne.babenhauserheide@disy.net} + \item Babenhauserheide Arne \email{arne.babenhauserheide@disy.net} (\href{https://orcid.org/0000-0003-1381-8277}{ORCID}) } Other contributors: diff --git a/man/as_cadenza_visualization.Rd b/man/as_cadenza_visualization.Rd index 1a3844a..335fff8 100644 --- a/man/as_cadenza_visualization.Rd +++ b/man/as_cadenza_visualization.Rd @@ -12,7 +12,7 @@ as_cadenza_visualization(res, plotfile) \item{plotfile}{The plot file created in the Plumber R file} } \value{ -res The Plumber response construct adjusted +The Plumber response construct with the plot data added } \description{ Prepare visualization results for Cadenza diff --git a/man/attribute_group.Rd b/man/attribute_group.Rd index 05b5710..9cd254d 100644 --- a/man/attribute_group.Rd +++ b/man/attribute_group.Rd @@ -2,6 +2,7 @@ % Please edit documentation in R/custom-serializer-capabilities.R \name{attribute_group} \alias{attribute_group} +\title{A group of attributes used in the extension.} \usage{ attribute_group(...) } diff --git a/man/parsers.Rd b/man/parsers.Rd index 6a760ea..67bc280 100644 --- a/man/parsers.Rd +++ b/man/parsers.Rd @@ -38,5 +38,4 @@ See \code{\link[plumber:register_parser]{plumber::registered_parsers()}} for a l \item \code{parser_delim()}: Parse any delimiter separated value data. Also see \code{\link[vroom:vroom]{vroom::vroom()}}. - }} diff --git a/man/serializers.Rd b/man/serializers.Rd index bee3aba..c5a6098 100644 --- a/man/serializers.Rd +++ b/man/serializers.Rd @@ -1,13 +1,17 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/custom-serializer-enrichment-calculation.R +% Please edit documentation in R/custom-serializer-enrichment-calculation.R, +% R/custom-serializer-visualization.R \name{serializer_multi} \alias{serializer_multi} \alias{serializer_cadenza_enrichment_calculation} +\alias{serializer_cadenza_visualization} \title{Custom serializers} \usage{ serializer_multi(serialize_fn, boundary = NULL, ...) serializer_cadenza_enrichment_calculation(...) + +serializer_cadenza_visualization(...) } \arguments{ \item{serialize_fn}{Function with which the individual parts will @@ -32,6 +36,9 @@ Custom serializers \item \code{serializer_cadenza_enrichment_calculation()}: Serialize the multipart-form required by Cadenza for enrichments and calculations +\item \code{serializer_cadenza_visualization()}: Serialize the multipart-form required by +Cadenza for visualizations + }} \examples{ \dontrun{