From 295262301068c9773a20851f9c71a404a8c8e999 Mon Sep 17 00:00:00 2001 From: eblondel Date: Mon, 30 Dec 2024 12:47:40 +0100 Subject: [PATCH] fix rdoc and tests --- NAMESPACE | 2 +- R/GMLCompoundCRS.R | 4 +-- R/ISOAbstractFeatureCatalogue.R | 4 +-- R/ISODataQualityPositionalAccuracy.R | 8 +++--- R/ISOFeatureTypeInfo.R | 2 +- R/ISOStandaloneQualityReportInformation.R | 2 +- man/GMLCompoundCRS.Rd | 4 +-- man/ISOAbsoluteExternalPositionalAccuracy.Rd | 4 +-- man/ISOAbstractPositionalAccuracy.Rd | 4 +-- man/ISOFeatureTypeInfo.Rd | 2 +- man/ISOStandaloneQualityReportInformation.Rd | 2 +- man/ISoAbstractFeatureCatalogue.Rd | 28 ++++++++++---------- man/geometa_coverage.Rd | 2 +- man/getISOMetadataSchemaFile.Rd | 14 ++++++++-- man/getISOMetadataSchemas.Rd | 6 ++--- man/setISOMetadataNamespaces.Rd | 11 -------- man/setISOMetadataSchemas.Rd | 12 +++++++-- man/setMetadataNamespaces.Rd | 23 ++++++++++++++++ 18 files changed, 82 insertions(+), 52 deletions(-) delete mode 100644 man/setISOMetadataNamespaces.Rd create mode 100644 man/setMetadataNamespaces.Rd diff --git a/NAMESPACE b/NAMESPACE index a3319b46..bde5c0a3 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -99,6 +99,7 @@ export(ISOAbstractDataEvaluation) export(ISOAbstractDataQuality) export(ISOAbstractDistribution) export(ISOAbstractExtent) +export(ISOAbstractFeatureCatalogue) export(ISOAbstractFeatureType) export(ISOAbstractFormat) export(ISOAbstractGenericName) @@ -404,7 +405,6 @@ export(ISOUsabilityElement) export(ISOUsage) export(ISOVectorSpatialRepresentation) export(ISOVerticalExtent) -export(ISoAbstractFeatureCatalogue) export(SWEAbstractDataComponent) export(SWEAbstractEncoding) export(SWEAbstractObject) diff --git a/R/GMLCompoundCRS.R b/R/GMLCompoundCRS.R index b3aa4013..bb17dfe1 100644 --- a/R/GMLCompoundCRS.R +++ b/R/GMLCompoundCRS.R @@ -4,8 +4,8 @@ #' @importFrom R6 R6Class #' @export #' @keywords ISO GML compound CRS -#' @return Object of \code{\link [R6]{R6Class}} for modelling an GMLCompoundCRS -#' @format \code{\link [R6]{R6Class}} object. +#' @return Object of \code{\link[R6]{R6Class}} for modelling an GMLCompoundCRS +#' @format \code{\link[R6]{R6Class}} object. #' #' @references #' ISO 19136:2007 Geographic Information -- Geographic Markup Language. diff --git a/R/ISOAbstractFeatureCatalogue.R b/R/ISOAbstractFeatureCatalogue.R index b32d9e97..bb112682 100644 --- a/R/ISOAbstractFeatureCatalogue.R +++ b/R/ISOAbstractFeatureCatalogue.R @@ -1,4 +1,4 @@ -#' ISoAbstractFeatureCatalogue +#' ISOAbstractFeatureCatalogue #' #' @docType class #' @importFrom R6 R6Class @@ -12,7 +12,7 @@ #' #' @author Emmanuel Blondel #' -ISoAbstractFeatureCatalogue <- R6Class("ISoAbstractFeatureCatalogue", +ISOAbstractFeatureCatalogue <- R6Class("ISOAbstractFeatureCatalogue", inherit = ISOAbstractCatalogue, private = list( xmlElement = "Abstract_FeatureCatalogue", diff --git a/R/ISODataQualityPositionalAccuracy.R b/R/ISODataQualityPositionalAccuracy.R index 18c98de1..b4da9a1e 100644 --- a/R/ISODataQualityPositionalAccuracy.R +++ b/R/ISODataQualityPositionalAccuracy.R @@ -8,9 +8,9 @@ #' @format \code{\link[R6]{R6Class}} object. #' #' @references -#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_AbstractDQ_PositionalAccuracy}{element_AbstractDQ_PositionalAccuracy} +#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_AbstractDQ_PositionalAccuracy} #' -#' - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_AbstractDQ_PositionalAccuracy}{element_AbstractDQ_PositionalAccuracy} +#' - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_AbstractDQ_PositionalAccuracy} #' #' @author Emmanuel Blondel #' @@ -61,9 +61,9 @@ ISOAbstractPositionalAccuracy <- R6Class("ISOAbstractPositionalAccuracy", #' xml <- dq$encode() #' #' @references -#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_DQ_AbsoluteExternalPositionalAccuracy}{element_DQ_AbsoluteExternalPositionalAccuracy} +#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_DQ_AbsoluteExternalPositionalAccuracy} #' -#' - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_DQ_AbsoluteExternalPositionalAccuracy}{element_DQ_AbsoluteExternalPositionalAccuracy} +#' - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_DQ_AbsoluteExternalPositionalAccuracy} #' #' @author Emmanuel Blondel #' diff --git a/R/ISOFeatureTypeInfo.R b/R/ISOFeatureTypeInfo.R index e35ebc43..fe8c6af9 100644 --- a/R/ISOFeatureTypeInfo.R +++ b/R/ISOFeatureTypeInfo.R @@ -34,7 +34,7 @@ ISOFeatureTypeInfo <- R6Class("ISOFeatureTypeInfo", }, #'@description Set feature type Name - #'@param name object of class \link{ISOGenericName} or \link{character} + #'@param name object of class \link{ISOAbstractGenericName} or \link{character} setFeatureTypeName = function(name){ if(!is(name, "ISOAbstractGenericName")){ name = ISOAbstractGenericName$new(value = name) diff --git a/R/ISOStandaloneQualityReportInformation.R b/R/ISOStandaloneQualityReportInformation.R index aae562f6..c9941062 100644 --- a/R/ISOStandaloneQualityReportInformation.R +++ b/R/ISOStandaloneQualityReportInformation.R @@ -36,7 +36,7 @@ ISOStandaloneQualityReportInformation <- R6Class("ISOStandaloneQualityReportInfo }, #'@description set Report reference - #'@param reportReference object of class \link{ISOCiation} + #'@param reportReference object of class \link{ISOCitation} setReportReference = function(reportReference){ if(!is(reportReference, "ISOCitation")){ stop("The argument should be an object of class 'ISOCitation'") diff --git a/man/GMLCompoundCRS.Rd b/man/GMLCompoundCRS.Rd index baa0d917..001c1909 100644 --- a/man/GMLCompoundCRS.Rd +++ b/man/GMLCompoundCRS.Rd @@ -5,10 +5,10 @@ \alias{GMLCompoundCRS} \title{GMLCompoundCRS} \format{ -\code{\link [R6]{R6Class}} object. +\code{\link[R6]{R6Class}} object. } \value{ -Object of \code{\link [R6]{R6Class}} for modelling an GMLCompoundCRS +Object of \code{\link[R6]{R6Class}} for modelling an GMLCompoundCRS } \description{ GMLCompoundCRS diff --git a/man/ISOAbsoluteExternalPositionalAccuracy.Rd b/man/ISOAbsoluteExternalPositionalAccuracy.Rd index 02d3e82d..c20139e0 100644 --- a/man/ISOAbsoluteExternalPositionalAccuracy.Rd +++ b/man/ISOAbsoluteExternalPositionalAccuracy.Rd @@ -42,9 +42,9 @@ ISOAbsoluteExternalPositionalAccuracy } \references{ -- ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_DQ_AbsoluteExternalPositionalAccuracy}{element_DQ_AbsoluteExternalPositionalAccuracy} +- ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_DQ_AbsoluteExternalPositionalAccuracy} - - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_DQ_AbsoluteExternalPositionalAccuracy}{element_DQ_AbsoluteExternalPositionalAccuracy} + - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_DQ_AbsoluteExternalPositionalAccuracy} } \author{ Emmanuel Blondel diff --git a/man/ISOAbstractPositionalAccuracy.Rd b/man/ISOAbstractPositionalAccuracy.Rd index 45739252..69ccf5e6 100644 --- a/man/ISOAbstractPositionalAccuracy.Rd +++ b/man/ISOAbstractPositionalAccuracy.Rd @@ -16,9 +16,9 @@ ISOAbstractPositionalAccuracy ISOAbstractPositionalAccuracy } \references{ -- ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_AbstractDQ_PositionalAccuracy}{element_AbstractDQ_PositionalAccuracy} +- ISO 19139 \url{https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_AbstractDQ_PositionalAccuracy} - - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_AbstractDQ_PositionalAccuracy}{element_AbstractDQ_PositionalAccuracy} + - ISO 19115-3 \url{https://schemas.isotc211.org/19157/-/mdq/1.2/mdq/#element_AbstractDQ_PositionalAccuracy} } \author{ Emmanuel Blondel diff --git a/man/ISOFeatureTypeInfo.Rd b/man/ISOFeatureTypeInfo.Rd index c3e37fa3..963a95d2 100644 --- a/man/ISOFeatureTypeInfo.Rd +++ b/man/ISOFeatureTypeInfo.Rd @@ -110,7 +110,7 @@ Set feature type Name \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{name}}{object of class \link{ISOGenericName} or \link{character}} +\item{\code{name}}{object of class \link{ISOAbstractGenericName} or \link{character}} } \if{html}{\out{
}} } diff --git a/man/ISOStandaloneQualityReportInformation.Rd b/man/ISOStandaloneQualityReportInformation.Rd index ca203fd1..f460135e 100644 --- a/man/ISOStandaloneQualityReportInformation.Rd +++ b/man/ISOStandaloneQualityReportInformation.Rd @@ -115,7 +115,7 @@ set Report reference \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{reportReference}}{object of class \link{ISOCiation}} +\item{\code{reportReference}}{object of class \link{ISOCitation}} } \if{html}{\out{
}} } diff --git a/man/ISoAbstractFeatureCatalogue.Rd b/man/ISoAbstractFeatureCatalogue.Rd index 81d5b205..66b89629 100644 --- a/man/ISoAbstractFeatureCatalogue.Rd +++ b/man/ISoAbstractFeatureCatalogue.Rd @@ -1,9 +1,9 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/ISOAbstractFeatureCatalogue.R \docType{class} -\name{ISoAbstractFeatureCatalogue} -\alias{ISoAbstractFeatureCatalogue} -\title{ISoAbstractFeatureCatalogue} +\name{ISOAbstractFeatureCatalogue} +\alias{ISOAbstractFeatureCatalogue} +\title{ISOAbstractFeatureCatalogue} \format{ \code{\link[R6]{R6Class}} object. } @@ -11,9 +11,9 @@ Object of \code{\link[R6]{R6Class}} for modelling a ISO abstract feature catalogue } \description{ -ISoAbstractFeatureCatalogue +ISOAbstractFeatureCatalogue -ISoAbstractFeatureCatalogue +ISOAbstractFeatureCatalogue } \references{ - ISO 19115-3 \url{https://schemas.isotc211.org/19110/-/fcc/2.2/fcc/#element_Abstract_FeatureCatalogue} @@ -25,13 +25,13 @@ Emmanuel Blondel \keyword{catalogue} \keyword{feature} \section{Super classes}{ -\code{\link[geometa:geometaLogger]{geometa::geometaLogger}} -> \code{\link[geometa:ISOAbstractObject]{geometa::ISOAbstractObject}} -> \code{\link[geometa:ISOAbstractCatalogue]{geometa::ISOAbstractCatalogue}} -> \code{ISoAbstractFeatureCatalogue} +\code{\link[geometa:geometaLogger]{geometa::geometaLogger}} -> \code{\link[geometa:ISOAbstractObject]{geometa::ISOAbstractObject}} -> \code{\link[geometa:ISOAbstractCatalogue]{geometa::ISOAbstractCatalogue}} -> \code{ISOAbstractFeatureCatalogue} } \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-ISoAbstractFeatureCatalogue-new}{\code{ISoAbstractFeatureCatalogue$new()}} -\item \href{#method-ISoAbstractFeatureCatalogue-clone}{\code{ISoAbstractFeatureCatalogue$clone()}} +\item \href{#method-ISOAbstractFeatureCatalogue-new}{\code{ISOAbstractFeatureCatalogue$new()}} +\item \href{#method-ISOAbstractFeatureCatalogue-clone}{\code{ISOAbstractFeatureCatalogue$clone()}} } } \if{html}{\out{ @@ -83,12 +83,12 @@ Emmanuel Blondel }} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ISoAbstractFeatureCatalogue-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ISOAbstractFeatureCatalogue-new}{}}} \subsection{Method \code{new()}}{ Initializes object \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ISoAbstractFeatureCatalogue$new(xml = NULL)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{ISOAbstractFeatureCatalogue$new(xml = NULL)}\if{html}{\out{
}} } \subsection{Arguments}{ @@ -100,12 +100,12 @@ Initializes object } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ISoAbstractFeatureCatalogue-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ISOAbstractFeatureCatalogue-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ISoAbstractFeatureCatalogue$clone(deep = FALSE)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{ISOAbstractFeatureCatalogue$clone(deep = FALSE)}\if{html}{\out{
}} } \subsection{Arguments}{ diff --git a/man/geometa_coverage.Rd b/man/geometa_coverage.Rd index 9e3ef826..148578a7 100644 --- a/man/geometa_coverage.Rd +++ b/man/geometa_coverage.Rd @@ -5,7 +5,7 @@ \alias{geometa_coverae} \title{geometa_coverage} \usage{ -geometa_coverage() +geometa_coverage(version) } \arguments{ \item{version}{main metadata standard version} diff --git a/man/getISOMetadataSchemaFile.Rd b/man/getISOMetadataSchemaFile.Rd index e441f45c..4291228c 100644 --- a/man/getISOMetadataSchemaFile.Rd +++ b/man/getISOMetadataSchemaFile.Rd @@ -4,8 +4,18 @@ \alias{getISOMetadataSchemaFile} \title{getISOMetadataSchemaFile} \usage{ -getISOMetadataSchemaFile(version = "19139") +getISOMetadataSchemaFile(version) +} +\arguments{ +\item{version}{the schema version} +} +\value{ +the internal path to the schema file } \description{ -getISOMetadataSchemaFile +\code{getISOMetadataSchemaFile} allows to get the schema file +in \pkg{geometa} +} +\author{ +Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com} } diff --git a/man/getISOMetadataSchemas.Rd b/man/getISOMetadataSchemas.Rd index 5e7824d3..ff2397d9 100644 --- a/man/getISOMetadataSchemas.Rd +++ b/man/getISOMetadataSchemas.Rd @@ -6,6 +6,9 @@ \usage{ getISOMetadataSchemas(version) } +\arguments{ +\item{version}{the schema version} +} \description{ \code{getISOMetadataSchemas} gets the schemas registered in \pkg{geometa} } @@ -14,6 +17,3 @@ getISOMetadataSchemas(version) getISOMetadataSchemas(version = "19115-3") } -\author{ -Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com} -} diff --git a/man/setISOMetadataNamespaces.Rd b/man/setISOMetadataNamespaces.Rd deleted file mode 100644 index f48fcdfa..00000000 --- a/man/setISOMetadataNamespaces.Rd +++ /dev/null @@ -1,11 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ISOMetadataNamespace.R -\name{setISOMetadataNamespaces} -\alias{setISOMetadataNamespaces} -\title{setMetadataNamespaces} -\usage{ -setISOMetadataNamespaces(version = "19139") -} -\description{ -setMetadataNamespaces -} diff --git a/man/setISOMetadataSchemas.Rd b/man/setISOMetadataSchemas.Rd index 0f67c47f..f275c37d 100644 --- a/man/setISOMetadataSchemas.Rd +++ b/man/setISOMetadataSchemas.Rd @@ -4,8 +4,16 @@ \alias{setISOMetadataSchemas} \title{setISOMetadataSchemas} \usage{ -setISOMetadataSchemas(version = "19139") +setISOMetadataSchemas(version) +} +\arguments{ +\item{version}{the schema version} } \description{ -setISOMetadataSchemas +\code{setISOMetadataSchemas} register the schemas in \pkg{geometa} +} +\examples{ + + setISOMetadataSchemas(version = "19115-3") + } diff --git a/man/setMetadataNamespaces.Rd b/man/setMetadataNamespaces.Rd new file mode 100644 index 00000000..dd0bfaa0 --- /dev/null +++ b/man/setMetadataNamespaces.Rd @@ -0,0 +1,23 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/ISOMetadataNamespace.R +\name{setMetadataNamespaces} +\alias{setMetadataNamespaces} +\alias{setISOMetadataNamespaces} +\title{setMetadataNamespaces} +\usage{ +setMetadataNamespaces(version) +} +\arguments{ +\item{version}{the standard version} +} +\description{ +\code{setMetadataNamespaces} sets the default list of namespaces +} +\examples{ + + getISOMetadataNamespaces() + +} +\author{ +Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com} +}