rdoc adjustments

opensdmx · Dec 16, 2024 · 0a61806 · 0a61806
1 parent f26eabf
commit 0a61806
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 20 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -56,10 +56,19 @@ export(SDMXStructureType)
 export(SDMXTimeDimension)
 export(SDMXType)
 export(SDMXUtilityData)
+export(addSDMXServiceProvider)
+export(findNamespace)
+export(findSDMXServiceProvider)
+export(getRegistryInterfaceResult)
+export(getSDMXServiceProviders)
+export(getSoapRequestResult)
 export(getStructureType)
+export(isRegistryInterfaceEnvelope)
+export(isSoapRequestEnvelope)
 export(readSDMX)
 export(rsdmxLogger)
 export(saveSDMX)
+export(setSDMXServiceProviders)
 import(R6)
 import(XML)
 import(httr)

diff --git a/R/SDMX-methods.R b/R/SDMX-methods.R
@@ -65,7 +65,7 @@ encodeSDMXOutput <- function(df){
 
 #' @name getNamespaces
 #' @docType methods
-#' @rdname SDMXStructureType-methods
+#' @rdname SDMX-methods
 #' @aliases getNamespaces,SDMX-method
 #' @title getNamespaces
 #' @description Access the namespaces of the SDMX-ML object
@@ -80,7 +80,7 @@ encodeSDMXOutput <- function(df){
 #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
 setGeneric("getNamespaces", function(obj) standardGeneric("getNamespaces"));
 
-#' @rdname SDMXStructureType-methods
+#' @rdname SDMX-methods
 #' @aliases getNamespaces,SDMX,ANY-method
 setMethod(f = "getNamespaces", signature = "SDMX", function(obj){
             return(namespaces.SDMX(obj@xmlObj));
@@ -111,7 +111,8 @@ setMethod(f = "getNamespaces", signature = "SDMX", function(obj){
 #' @seealso \link{SDMX-class} \link{getNamespaces} 
 #' 
 #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
-
+#' @export
+#' 
 findNamespace <- function(namespaces, messageType){
   regexp <- paste(messageType, "$", sep = "")
   ns <- c(ns = namespaces$uri[grep(regexp, namespaces$uri, ignore.case = TRUE)])
@@ -137,8 +138,8 @@ findNamespace <- function(namespaces, messageType){
 #' @seealso \link{SDMX-class} \link{readSDMX}
 #' 
 #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
-#' 
-
+#' @export
+#'
 isSoapRequestEnvelope <- function(xmlObj, namespaces){
   return(tolower(xmlName(xmlRoot(xmlObj))) == "envelope")
 }
@@ -160,7 +161,8 @@ isSoapRequestEnvelope <- function(xmlObj, namespaces){
 #' @seealso \link{SDMX-class} \link{readSDMX}
 #' 
 #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
-
+#' @export
+#' 
 getSoapRequestResult <- function(xmlObj){
   body <- xmlChildren(xmlRoot(xmlObj))
   response <- xmlChildren(body[[1]]); rm(body);
@@ -188,8 +190,8 @@ getSoapRequestResult <- function(xmlObj){
 #' @seealso \link{SDMX-class} \link{readSDMX}
 #' 
 #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
+#' @export
 #' 
-
 isRegistryInterfaceEnvelope <- function(xmlObj, nativeRoot){
   root <- xmlRoot(xmlObj)
   if(nativeRoot) root <- root[[1]]
@@ -213,7 +215,8 @@ isRegistryInterfaceEnvelope <- function(xmlObj, nativeRoot){
 #' @seealso \link{SDMX-class} \link{readSDMX}
 #' 
 #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
-
+#' @export
+#'
 getRegistryInterfaceResult <- function(xmlObj){
   sdmxDoc <- xmlDoc(xmlChildren(xmlRoot(xmlObj))[[1]])
   return(sdmxDoc)

diff --git a/R/SDMXData-methods.R b/R/SDMXData-methods.R
@@ -140,9 +140,9 @@ addLabels.SDMXData <- function(data, dsd){
 #' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
 setGeneric("setDSD", function(obj, dsd) standardGeneric("setDSD"));
 
-#' @rdname SDMXStructureType-methods
-#' @aliases setDSD,SDMXData,ANY-method
-setMethod(f = "setDSD", signature = "SDMXData", function(obj, dsd){
+#' @rdname SDMX-methods
+#' @aliases setDSD,SDMXData,SDMXDataStructureDefinition-method
+setMethod(f = "setDSD", signature = c("SDMXData", "SDMXDataStructureDefinition"), function(obj, dsd){
   slot(obj, "dsd") <- dsd
   return(obj)
 })
diff --git a/R/SDMXServiceProvider-methods.R b/R/SDMXServiceProvider-methods.R
@@ -62,7 +62,8 @@ SDMXServiceProvider <- function(agencyId, name,
 #' 
 #' @seealso \link{getSDMXServiceProviders} \link{addSDMXServiceProvider}
 #'          \link{findSDMXServiceProvider} \link{readSDMX}
-#'
+#' @export
+#' 
 setSDMXServiceProviders <- function(){ # nocov start
 
   #international data providers
@@ -601,7 +602,8 @@ setSDMXServiceProviders <- function(){ # nocov start
 #'   
 #' @seealso \link{getSDMXServiceProviders} \link{findSDMXServiceProvider}
 #'          \link{readSDMX}
-#'          
+#' @export
+#'         
 addSDMXServiceProvider <- function(provider){
   .rsdmx.options$providers <- new("SDMXServiceProviders",
                                   providers = c(slot(.rsdmx.options$providers, "providers"), provider)
@@ -626,7 +628,8 @@ addSDMXServiceProvider <- function(provider){
 #' 
 #' @seealso \link{addSDMXServiceProvider} \link{findSDMXServiceProvider}
 #'          \link{readSDMX}
-#'          
+#' @export
+#'        
 getSDMXServiceProviders <- function(){
   out <- .rsdmx.options$providers
   return(out)
@@ -656,7 +659,7 @@ getSDMXServiceProviders <- function(){
 #'   
 #' @seealso \link{getSDMXServiceProviders} \link{addSDMXServiceProvider}
 #'          \link{readSDMX}
-#'
+#' @export
 findSDMXServiceProvider <- function(agencyId){
   if(is.null(agencyId)) return(NULL)
   res <- unlist(lapply(slot(getSDMXServiceProviders(),"providers"),

diff --git a/R/SDMXStructureType-methods.R b/R/SDMXStructureType-methods.R
@@ -80,11 +80,11 @@ type.SDMXStructureType <- function(xmlObj, namespaces, resource){
 #generics
 #' @export
 #' @docType methods
-#' @rdname SDMXStructureType-methods
+#' @rdname SDMX-methods
 setGeneric("getStructureType", function(obj) standardGeneric("getStructureType"));
 
 #methods
-#' @rdname SDMXStructureType-methods
+#' @rdname SDMX-methods
 #' @aliases getStructureType,SDMXStructureType,ANY-method
 setMethod(f = "getStructureType", signature = "SDMXStructureType", function(obj){
             return(obj@subtype)

diff --git a/man/SDMXStructureType-methods.Rd → man/SDMX-methods.Rd b/man/SDMXStructureType-methods.Rd → man/SDMX-methods.Rd