Skip to content

Commit

Permalink
fix Rd
Browse files Browse the repository at this point in the history
  • Loading branch information
eblondel committed Jun 25, 2024
1 parent 5a06704 commit 720e4d5
Show file tree
Hide file tree
Showing 173 changed files with 491 additions and 481 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ tests/pycsw
^_pkgdown\.yml$
^docs$
^pkgdown$
.REnviron
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: ows4R
Version: 0.4
Date: 2024-06-17
Date: 2024-06-25
Title: Interface to OGC Web-Services (OWS)
Authors@R: c(person("Emmanuel", "Blondel", role = c("aut", "cre"), email = "[email protected]", comment = c(ORCID = "0000-0002-5870-5762")),
person("Alexandre", "Bennici", role = c("ctb"), comment = c(ORCID = "0000-0003-2160-3487")),
Expand All @@ -18,5 +18,5 @@ License: MIT + file LICENSE
URL: https://github.com/eblondel/ows4R, https://eblondel.github.io/ows4R/, https://www.ogc.org/standards/
BugReports: https://github.com/eblondel/ows4R/issues
LazyLoad: yes
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
VignetteBuilder: knitr
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [ows4R 0.4](https://github.com/eblondel/ows4R) | [![CRAN_Status_Badge](https://img.shields.io/badge/CRAN-unavailable-red.svg)](https://github.com/eblondel/ows4R)
## [ows4R 0.4](https://github.com/eblondel/ows4R) | [![CRAN_Status_Badge](https://img.shields.io/badge/CRAN-published-blue.svg)](https://github.com/eblondel/ows4R)

**Corrections**

Expand Down
4 changes: 2 additions & 2 deletions R/CASClient.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#' @docType class
#' @export
#' @keywords CAS Central Authentication Service
#' @return Object of \code{\link{R6Class}} with methods for interfacing a Central Authentication Service (CAS).
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} with methods for interfacing a Central Authentication Service (CAS).
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note Class used internally by \pkg{ows4R}
#'
Expand Down
4 changes: 2 additions & 2 deletions R/CSWCapabilities.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
#' @docType class
#' @export
#' @keywords OGC CSW Capabilities
#' @return Object of \code{\link{R6Class}} with methods for interfacing an OGC
#' @return Object of \code{\link[R6]{R6Class}} with methods for interfacing an OGC
#' Catalogue Service for the Web (CSW) Get Capabilities document.
#' @format \code{\link{R6Class}} object.
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note Class used to read a \code{CSWCapabilities} document. The use of \code{CSWClient} is
#' recommended instead to benefit from the full set of capabilities associated to a CSW server.
Expand Down
4 changes: 2 additions & 2 deletions R/CSWClient.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
#' @docType class
#' @export
#' @keywords OGC CSW catalogue service web
#' @return Object of \code{\link{R6Class}} with methods for interfacing an OGC
#' @return Object of \code{\link[R6]{R6Class}} with methods for interfacing an OGC
#' Catalogue Service for the Web.
#' @format \code{\link{R6Class}} object.
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' \dontrun{
Expand Down
4 changes: 2 additions & 2 deletions R/CSWConstraint.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
#' @docType class
#' @export
#' @keywords OGC Filter
#' @return Object of \code{\link{R6Class}} for modelling an CSW Constraint
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an CSW Constraint
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' filter <- OGCFilter$new( PropertyIsEqualTo$new("apiso:Identifier", "12345") )
Expand Down
4 changes: 2 additions & 2 deletions R/CSWDescribeRecord.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#' @docType class
#' @export
#' @keywords OGC CSW DescribeRecord
#' @return Object of \code{\link{R6Class}} for modelling a CSW DescribeRecord request
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling a CSW DescribeRecord request
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note Class used internally by \pkg{ows4R} to trigger a CSW DescribeRecord request
#'
Expand Down
4 changes: 2 additions & 2 deletions R/CSWGetRecordById.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#' @docType class
#' @export
#' @keywords OGC CSW GetRecordById
#' @return Object of \code{\link{R6Class}} for modelling a CSW GetRecordById request
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling a CSW GetRecordById request
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note Class used internally by \pkg{ows4R} to trigger a CSW GetRecordById request
#'
Expand Down
4 changes: 2 additions & 2 deletions R/CSWGetRecords.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#' @docType class
#' @export
#' @keywords OGC CSW GetRecords
#' @return Object of \code{\link{R6Class}} for modelling a CSW GetRecords request
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling a CSW GetRecords request
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note Class used internally by \pkg{ows4R} to trigger a CSW GetRecords request
#'
Expand Down
4 changes: 2 additions & 2 deletions R/CSWHarvest.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#' @docType class
#' @export
#' @keywords OGC CSW Harvest
#' @return Object of \code{\link{R6Class}} for modelling a CSW Harvest request
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling a CSW Harvest request
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note Class used internally by \pkg{ows4R} to trigger a CSW Harvest request
#'
Expand Down
4 changes: 2 additions & 2 deletions R/CSWQuery.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
#' @docType class
#' @export
#' @keywords OGC Query
#' @return Object of \code{\link{R6Class}} for modelling an CSW Query
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an CSW Query
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' #CSWQuery - elementSetName
Expand Down
4 changes: 2 additions & 2 deletions R/CSWRecordProperty.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
#' @docType class
#' @export
#' @keywords CSW RecordProperty
#' @return Object of \code{\link{R6Class}} for modelling an CSW RecordProperty
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an CSW RecordProperty
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' rp <- CSWRecordProperty$new(name = "NAME", value = "VALUE")
Expand Down
4 changes: 2 additions & 2 deletions R/CSWTransaction.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#' @docType class
#' @export
#' @keywords OGC CSW Transaction
#' @return Object of \code{\link{R6Class}} for modelling a CSW Transaction request
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling a CSW Transaction request
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note Class used internally by \pkg{ows4R} to trigger a CSW Transaction request
#'
Expand Down
8 changes: 4 additions & 4 deletions R/OGCAbstractObject.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
#' @docType class
#' @export
#' @keywords OGC Abstract Object
#' @return Object of \code{\link{R6Class}} for modelling an OGCAbstractObject
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an OGCAbstractObject
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note abstract class used by \pkg{ows4R}
#'
Expand Down Expand Up @@ -149,7 +149,7 @@ OGCAbstractObject <- R6Class("OGCAbstractObject",
attrs = list(),

#'@description Initializes an object extending \link{OGCAbstractObject}
#'@param xml object of class \link{XMLInternalNode-class} from \pkg{XML}
#'@param xml object of class \link[XML]{XMLInternalNode-class} from \pkg{XML}
#'@param element element name
#'@param namespacePrefix namespace prefix for XML encoding
#'@param attrs list of attributes
Expand Down Expand Up @@ -333,7 +333,7 @@ OGCAbstractObject <- R6Class("OGCAbstractObject",
#'@param geometa_validate Relates to \pkg{geometa} object ISO validation. Default is \code{TRUE}
#'@param geometa_inspire Relates to \pkg{geometa} object INSPIRE validation. Default is \code{FALSE}
#'@param geometa_inspireValidator Relates to \pkg{geometa} object INSPIRE validation. Default is \code{NULL}
#'@return an object of class \link{XMLInternalNode-class} from \pkg{XML}
#'@return an object of class \link[XML]{XMLInternalNode-class} from \pkg{XML}
encode = function(addNS = TRUE, geometa_validate = TRUE,
geometa_inspire = FALSE, geometa_inspireValidator = NULL){

Expand Down
70 changes: 35 additions & 35 deletions R/OGCExpression.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
#' @docType class
#' @export
#' @keywords OGC Expression
#' @return Object of \code{\link{R6Class}} for modelling an OGC Expression
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an OGC Expression
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note abstract class
#'
Expand Down Expand Up @@ -51,8 +51,8 @@ OGCExpression <- R6Class("OGCExpression",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryComparisonOpType
#' @return Object of \code{\link{R6Class}} for modelling an BinaryComparisonOpType
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an BinaryComparisonOpType
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @note abstract super class of all the property operation classes
#'
Expand Down Expand Up @@ -87,8 +87,8 @@ BinaryComparisonOpType <- R6Class("BinaryComparisonOpType",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryComparisonOpType PropertyIsEqualTo
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsEqualTo
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsEqualTo
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsEqualTo$new(PropertyName = "property", Literal = "value")
Expand Down Expand Up @@ -121,8 +121,8 @@ PropertyIsEqualTo <-R6Class("PropertyIsEqualTo",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryComparisonOpType PropertyIsNotEqualTo
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsNotEqualTo
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsNotEqualTo
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsNotEqualTo$new(PropertyName = "property", Literal = "value")
Expand Down Expand Up @@ -155,8 +155,8 @@ PropertyIsNotEqualTo <-R6Class("PropertyIsNotEqualTo",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryComparisonOpType PropertyIsLessThan
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsLessThan
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsLessThan
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsLessThan$new(PropertyName = "property", Literal = "value")
Expand Down Expand Up @@ -189,8 +189,8 @@ PropertyIsLessThan <-R6Class("PropertyIsLessThan",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryComparisonOpType PropertyIsGreaterThan
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsGreaterThan
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsGreaterThan
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsGreaterThan$new(PropertyName = "property", Literal = "value")
Expand Down Expand Up @@ -223,8 +223,8 @@ PropertyIsGreaterThan <-R6Class("PropertyIsGreaterThan",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryComparisonOpType PropertyIsLesserThanOrEqualTo
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsLesserThanOrEqualTo
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsLesserThanOrEqualTo
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsLessThanOrEqualTo$new(PropertyName = "property", Literal = "value")
Expand Down Expand Up @@ -257,8 +257,8 @@ PropertyIsLessThanOrEqualTo <-R6Class("PropertyIsLessThanOrEqualTo",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryComparisonOpType PropertyIsGreaterThanOrEqualTo
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsGreaterThanOrEqualTo
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsGreaterThanOrEqualTo
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsGreaterThanOrEqualTo$new(PropertyName = "property", Literal = "value")
Expand Down Expand Up @@ -291,8 +291,8 @@ PropertyIsGreaterThanOrEqualTo <-R6Class("PropertyIsGreaterThanOrEqualTo",
#' @docType class
#' @export
#' @keywords OGC Expression PropertyIsLike
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsLike
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsLike
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsLike$new(PropertyName = "property", Literal = "value")
Expand Down Expand Up @@ -345,8 +345,8 @@ PropertyIsLike <- R6Class("PropertyIsLike",
#' @docType class
#' @export
#' @keywords OGC Expression PropertyIsNull
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsNull
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsNull
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsNull$new(PropertyName = "property")
Expand Down Expand Up @@ -377,8 +377,8 @@ PropertyIsNull <- R6Class("PropertyIsNull",
#' @docType class
#' @export
#' @keywords OGC Expression PropertyIsBetween
#' @return Object of \code{\link{R6Class}} for modelling an PropertyIsBetween
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an PropertyIsBetween
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsBetween$new(PropertyName = "property", lower = 1, upper = 10)
Expand Down Expand Up @@ -417,8 +417,8 @@ PropertyIsBetween <- R6Class("PropertyIsBetween",
#' @docType class
#' @export
#' @keywords OGC Expression BBOX
#' @return Object of \code{\link{R6Class}} for modelling an BBOX
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an BBOX
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' bbox <- OWSUtils$toBBOX(-180,-90,180,90)
Expand All @@ -436,7 +436,7 @@ BBOX <- R6Class("BBOX",
public = list(
#'@field PropertyName property name field for XML encoding
PropertyName = "ows:BoundingBox",
#'@field Envelope envelope as object of class \link{GMLEnvelope} from \pkg{geometa}
#'@field Envelope envelope as object of class \link[geometa]{GMLEnvelope} from \pkg{geometa}
Envelope = NULL,

#'@description Initializes a \link{BBOX} expression
Expand All @@ -460,8 +460,8 @@ BBOX <- R6Class("BBOX",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryLogicOpType
#' @return Object of \code{\link{R6Class}} for modelling an BinaryLogicOpType
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an BinaryLogicOpType
#' @format \code{\link[R6]{R6Class}} object.
#' @note abstract super class of all the binary logical operation classes
BinaryLogicOpType <- R6Class("BinaryLogicOpType",
inherit = OGCExpression,
Expand Down Expand Up @@ -500,8 +500,8 @@ BinaryLogicOpType <- R6Class("BinaryLogicOpType",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryLogicOpType And
#' @return Object of \code{\link{R6Class}} for modelling an And operator
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an And operator
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr1 <- PropertyIsEqualTo$new(PropertyName = "property1", Literal = "value1")
Expand Down Expand Up @@ -531,8 +531,8 @@ And <- R6Class("And",
#' @docType class
#' @export
#' @keywords OGC Expression BinaryLogicOpType Or
#' @return Object of \code{\link{R6Class}} for modelling an Or operator
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an Or operator
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr1 <- PropertyIsEqualTo$new(PropertyName = "property1", Literal = "value1")
Expand Down Expand Up @@ -564,8 +564,8 @@ Or <- R6Class("Or",
#' @docType class
#' @export
#' @keywords OGC Expression UnaryLogicOpType
#' @return Object of \code{\link{R6Class}} for modelling an UnaryLogicOpType
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an UnaryLogicOpType
#' @format \code{\link[R6]{R6Class}} object.
#' @note abstract super class of all the unary logical operation classes
UnaryLogicOpType <- R6Class("UnaryLogicOpType",
inherit = OGCExpression,
Expand Down Expand Up @@ -600,8 +600,8 @@ UnaryLogicOpType <- R6Class("UnaryLogicOpType",
#' @docType class
#' @export
#' @keywords OGC Expression UnaryLogicOpType Not
#' @return Object of \code{\link{R6Class}} for modelling an Not
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an Not
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsEqualTo$new(PropertyName = "property", Literal = "value")
Expand Down
4 changes: 2 additions & 2 deletions R/OGCFilter.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
#' @docType class
#' @export
#' @keywords OGC Filter
#' @return Object of \code{\link{R6Class}} for modelling an OGC Filter
#' @format \code{\link{R6Class}} object.
#' @return Object of \code{\link[R6]{R6Class}} for modelling an OGC Filter
#' @format \code{\link[R6]{R6Class}} object.
#'
#' @examples
#' expr <- PropertyIsEqualTo$new(PropertyName = "property", Literal = "value")
Expand Down
Loading

0 comments on commit 720e4d5

Please sign in to comment.