From 01c64006aa13a1d798581559b4cf26ffb17fbae2 Mon Sep 17 00:00:00 2001 From: eblondel Date: Sun, 19 May 2024 22:44:52 +0200 Subject: [PATCH] Rdoc --- R/geoflow.R | 3 +-- R/geoflow_utils.R | 1 - man/geoflow.Rd | 8 ++++++++ man/geoflow_entity.Rd | 20 ++++++++++++++++++++ man/geoflow_handler.Rd | 12 +++++++++++- 5 files changed, 40 insertions(+), 4 deletions(-) diff --git a/R/geoflow.R b/R/geoflow.R index 7121e154..de2efc6f 100644 --- a/R/geoflow.R +++ b/R/geoflow.R @@ -1,7 +1,6 @@ #' @name geoflow #' @aliases geoflow-package #' @aliases geoflow -#' @docType package #' #' @import R6 #' @import methods @@ -49,4 +48,4 @@ #' #'@author Emmanuel Blondel \email{emmanuel.blondel1@@gmail.com} #' -NULL \ No newline at end of file +"_PACKAGE" \ No newline at end of file diff --git a/R/geoflow_utils.R b/R/geoflow_utils.R index 786570f6..b6a53e2c 100644 --- a/R/geoflow_utils.R +++ b/R/geoflow_utils.R @@ -692,7 +692,6 @@ getDBTableComment = function(dbi, schema, table){ #'@param table table #'@param column_index table column index #'@return the table comment - #'@author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com} #'@export getDBTableColumnComment = function(dbi, schema, table, column_index){ diff --git a/man/geoflow.Rd b/man/geoflow.Rd index 753229fb..ff141377 100644 --- a/man/geoflow.Rd +++ b/man/geoflow.Rd @@ -16,6 +16,14 @@ actions will allow to cross-share (meta)data resources in each action performed, (eg. reference Zenodo DOIS in Geonetwork/Geoserver metadata, reference Geonetwork/Geoserver links in Zenodo or EML metadata). The use of standardized configuration files allows fully reproducible workflows, in compliance with FAIR (Findable, Accessible, Interoperable, Reusable) principles. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/r-geoflow/geoflow} + \item Report bugs at \url{https://github.com/r-geoflow/geoflow} +} + } \author{ Emmanuel Blondel \email{emmanuel.blondel1@gmail.com} diff --git a/man/geoflow_entity.Rd b/man/geoflow_entity.Rd index 417b56ad..5556cc48 100644 --- a/man/geoflow_entity.Rd +++ b/man/geoflow_entity.Rd @@ -97,6 +97,7 @@ Emmanuel Blondel \item \href{#method-geoflow_entity-getEntityJobDirPath}{\code{geoflow_entity$getEntityJobDirPath()}} \item \href{#method-geoflow_entity-prepareEntityJobDir}{\code{geoflow_entity$prepareEntityJobDir()}} \item \href{#method-geoflow_entity-copyDataToJobDir}{\code{geoflow_entity$copyDataToJobDir()}} +\item \href{#method-geoflow_entity-enrichWithDatatypes}{\code{geoflow_entity$enrichWithDatatypes()}} \item \href{#method-geoflow_entity-enrichWithData}{\code{geoflow_entity$enrichWithData()}} \item \href{#method-geoflow_entity-enrichSpatialCoverageFromDB}{\code{geoflow_entity$enrichSpatialCoverageFromDB()}} \item \href{#method-geoflow_entity-enrichWithFeatures}{\code{geoflow_entity$enrichWithFeatures()}} @@ -604,6 +605,25 @@ geoflow job directory. \describe{ \item{\code{config}}{geoflow config object} +\item{\code{jobdir}}{relative path of the job directory} +} +\if{html}{\out{}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-geoflow_entity-enrichWithDatatypes}{}}} +\subsection{Method \code{enrichWithDatatypes()}}{ +Function that will scan zip data files and resolve data objects sourceType and uploadType +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{geoflow_entity$enrichWithDatatypes(config, jobdir = NULL)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{config}}{geoflow config object} + \item{\code{jobdir}}{relative path of the job directory} } \if{html}{\out{
}} diff --git a/man/geoflow_handler.Rd b/man/geoflow_handler.Rd index 56505a37..df1543d2 100644 --- a/man/geoflow_handler.Rd +++ b/man/geoflow_handler.Rd @@ -57,6 +57,10 @@ Emmanuel Blondel \item{\code{options}}{options} \item{\code{available_options}}{available options} + +\item{\code{status}}{status} + +\item{\code{notes}}{notes} } \if{html}{\out{}} } @@ -82,7 +86,9 @@ Initializes a \link{geoflow_handler} fun = NULL, script = NULL, options = list(), - available_options = list() + available_options = list(), + status = "active", + notes = "" )}\if{html}{\out{}} } @@ -102,6 +108,10 @@ Initializes a \link{geoflow_handler} \item{\code{options}}{action options} \item{\code{available_options}}{available options for the action} + +\item{\code{status}}{status (active/deprecated)} + +\item{\code{notes}}{notes} } \if{html}{\out{}} }