Skip to content

Commit

Permalink
#181 M5 - rdoc/standard references for GCO
Browse files Browse the repository at this point in the history
  • Loading branch information
eblondel committed Dec 9, 2024
1 parent c1f4219 commit 9da056e
Show file tree
Hide file tree
Showing 42 changed files with 124 additions and 65 deletions.
4 changes: 3 additions & 1 deletion R/ISOAngle.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Angle}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Angle}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBaseBoolean.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Boolean}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Boolean}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBaseCharacterString.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_CharacterString}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_CharacterString}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBaseDate.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Date}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Date}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBaseDateTime.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_DateTime}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_DateTime}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBaseDecimal.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Decimal}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Decimal}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBaseInteger.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Integer}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Integer}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBaseReal.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Real}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Real}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOBinary.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
#' bin <- ISOBinary$new(value = "http://someuri")
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Binary}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Binary}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
13 changes: 3 additions & 10 deletions R/ISODistance.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,11 @@
#' @keywords ISO measure length distance
#' @return Object of \code{\link{R6Class}} for modelling an ISO Distance measure
#' @format \code{\link{R6Class}} object.
#'
#' @section Methods:
#' \describe{
#' \item{\code{new(xml,value, uom, useUomURI)}}{
#' This method is used to instantiate an ISODistance. The \code{uom} argument represents
#' the symbol of unit of measure used. The parameter \code{useUomURI} can be used to
#' set the uom as URI, its default value is \code{FALSE}.
#' }
#' }
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Distance}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Distance}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOLength.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Length}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Length}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
5 changes: 2 additions & 3 deletions R/ISOLocalName.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_LocalName}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand All @@ -17,8 +17,7 @@ ISOLocalName <- R6Class("ISOLocalName",
private = list(
xmlElement = "LocalName",
xmlNamespacePrefix = list(
"19139" = "GCO",
"19115-3" = "GCO"
"19139" = "GCO"
)
),
public = list(
Expand Down
6 changes: 4 additions & 2 deletions R/ISOMeasure.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Measure}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Measure}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down Expand Up @@ -40,7 +42,7 @@ ISOMeasure <- R6Class("ISOMeasure",
}
self$value = value
uomAttr <- uom
if(useUomURI){
if(useUomURI & getMetadataStandard() == "19139"){
uomAttr <- sprintf("http://schemas.opengis.net/iso/19139/20070417/resources/uom/gmxUom.xml#xpointer(//*[@gml:id='%s'])", uomAttr)
}
self$attrs[["uom"]] <- uomAttr
Expand Down
4 changes: 3 additions & 1 deletion R/ISOMemberName.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_MemberName}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_MemberName}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOMultiplicity.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
#' xml <- md$encode()
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Multiplicity}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Multiplicity}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOMultiplicityRange.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
#' xml <- md$encode()
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_MultiplicityRange}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_MultiplicityRange}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISORecordType.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_RecordType}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_RecordType}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOScale.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_Scale}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_Scale}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOScopedName.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
#' @format \code{\link{R6Class}} object.
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_ScopedName}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_ScopedName}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOTypeName.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
#' xml <- typeName$encode()
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_TypeName}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_TypeName}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion R/ISOUnlimitedInteger.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @note Class used by geometa internal XML decoder/encoder
#'
#' @references
#' ISO/TS 19103:2005 Geographic information -- Conceptual schema language
#' - ISO 19139 \url{https://schemas.isotc211.org/19139/-/gco/1.0/gco/#element_UnlimitedInteger}
#'
#' - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/gco/1.0/gco/#element_UnlimitedInteger}
#'
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
Expand Down
4 changes: 3 additions & 1 deletion man/ISOAngle.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBaseBoolean.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBaseCharacterString.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBaseDate.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBaseDateTime.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBaseDecimal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBaseInteger.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBaseReal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOBinary.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 3 additions & 12 deletions man/ISODistance.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/ISOLength.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 9da056e

Please sign in to comment.