From 91ef359165df7faf371f8f18eea34d09948583e0 Mon Sep 17 00:00:00 2001 From: eblondel Date: Mon, 16 Dec 2024 22:18:20 +0100 Subject: [PATCH] update rdoc --- R/SDMXData-methods.R | 12 ++++++------ R/SDMXStructureType-methods.R | 10 +++++++--- man/SDMX-methods.Rd | 15 ++------------- man/SDMXData-method.Rd | 4 ++-- man/SDMXStructureType-methods.Rd | 18 ++++++++++++++++++ 5 files changed, 35 insertions(+), 24 deletions(-) create mode 100644 man/SDMXStructureType-methods.Rd diff --git a/R/SDMXData-methods.R b/R/SDMXData-methods.R index 8ef7d93..6d0d486 100644 --- a/R/SDMXData-methods.R +++ b/R/SDMXData-methods.R @@ -126,10 +126,11 @@ addLabels.SDMXData <- function(data, dsd){ #' @name setDSD #' @docType methods #' @rdname SDMXData-method -#' @aliases setDSD,SDMXData-method +#' @aliases setDSD,SDMXData,SDMXDataStructureDefinition-method #' @title setDSD -#' @description set the 'dsd' slot of a \code{SDMXData} object -#' @usage setDSD(obj, dsd) +#' @description set the dsd slot of a \code{SDMXData} object +#' @usage +#' setDSD(obj, dsd) #' #' @param obj An object deriving from class "SDMXData" #' @param dsd An object of class "SDMXDataStructureDefinition" @@ -140,9 +141,8 @@ addLabels.SDMXData <- function(data, dsd){ #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com} setGeneric("setDSD", function(obj, dsd) standardGeneric("setDSD")); -#' @rdname SDMX-methods -#' @aliases setDSD,SDMXData,SDMXDataStructureDefinition-method -setMethod(f = "setDSD", signature = c("SDMXData", "SDMXDataStructureDefinition"), function(obj, dsd){ +#' @rdname SDMXData-methods +setMethod(f = "setDSD", signature = c("SDMXData","SDMXDataStructureDefinition"), function(obj, dsd){ slot(obj, "dsd") <- dsd return(obj) }) diff --git a/R/SDMXStructureType-methods.R b/R/SDMXStructureType-methods.R index a4587a5..494ad76 100644 --- a/R/SDMXStructureType-methods.R +++ b/R/SDMXStructureType-methods.R @@ -79,13 +79,17 @@ type.SDMXStructureType <- function(xmlObj, namespaces, resource){ #generics #' @export +#' @name getStructureType +#' @title getStructureType #' @docType methods -#' @rdname SDMX-methods +#' @rdname SDMXStructureType-methods +#' @usage +#' getStructureType(obj) +#' @param obj object of class "SDMX" setGeneric("getStructureType", function(obj) standardGeneric("getStructureType")); #methods -#' @rdname SDMX-methods -#' @aliases getStructureType,SDMXStructureType,ANY-method +#' @rdname SDMXStructureType-methods setMethod(f = "getStructureType", signature = "SDMXStructureType", function(obj){ return(obj@subtype) }) diff --git a/man/SDMX-methods.Rd b/man/SDMX-methods.Rd index 05c68a9..5bebba5 100644 --- a/man/SDMX-methods.Rd +++ b/man/SDMX-methods.Rd @@ -1,26 +1,15 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/SDMXStructureType-methods.R, R/SDMX-methods.R, -% R/SDMXData-methods.R +% Please edit documentation in R/SDMX-methods.R \docType{methods} -\name{getStructureType} -\alias{getStructureType} -\alias{getStructureType,SDMXStructureType-method} -\alias{getStructureType,SDMXStructureType,ANY-method} +\name{getNamespaces} \alias{getNamespaces} \alias{getNamespaces,SDMX-method} \alias{getNamespaces,SDMX,ANY-method} -\alias{setDSD,SDMXData,SDMXDataStructureDefinition-method} \title{getNamespaces} \usage{ -getStructureType(obj) - -\S4method{getStructureType}{SDMXStructureType}(obj) - getNamespaces(obj) \S4method{getNamespaces}{SDMX}(obj) - -\S4method{setDSD}{SDMXData,SDMXDataStructureDefinition}(obj, dsd) } \arguments{ \item{obj}{An object deriving from class "SDMX"} diff --git a/man/SDMXData-method.Rd b/man/SDMXData-method.Rd index 9142843..f959f00 100644 --- a/man/SDMXData-method.Rd +++ b/man/SDMXData-method.Rd @@ -3,7 +3,7 @@ \docType{methods} \name{setDSD} \alias{setDSD} -\alias{setDSD,SDMXData-method} +\alias{setDSD,SDMXData,SDMXDataStructureDefinition-method} \title{setDSD} \usage{ setDSD(obj, dsd) @@ -17,7 +17,7 @@ setDSD(obj, dsd) the 'obj' object of class "SDMXData" enriched with the dsd } \description{ -set the 'dsd' slot of a \code{SDMXData} object +set the dsd slot of a \code{SDMXData} object } \seealso{ \link{SDMXData-class} diff --git a/man/SDMXStructureType-methods.Rd b/man/SDMXStructureType-methods.Rd new file mode 100644 index 0000000..08b9878 --- /dev/null +++ b/man/SDMXStructureType-methods.Rd @@ -0,0 +1,18 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/SDMXStructureType-methods.R +\docType{methods} +\name{getStructureType} +\alias{getStructureType} +\alias{getStructureType,SDMXStructureType-method} +\title{getStructureType} +\usage{ +getStructureType(obj) + +\S4method{getStructureType}{SDMXStructureType}(obj) +} +\arguments{ +\item{obj}{object of class "SDMX"} +} +\description{ +getStructureType +}