Re-jigged the class implementation to get better support from roxygen2 and CRAN check(). Majority of public functions are documented (remaining are the CRUD functions)

This commit is contained in:
2026-01-28 12:47:12 +00:00
parent b03c2691cd
commit 4a38372fc9
54 changed files with 900 additions and 279 deletions

View File

@@ -0,0 +1,30 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/DBClient-dbCollect.R
\name{DBClient$collectGeometries}
\alias{DBClient$collectGeometries}
\title{DBClient$collectGeometries}
\arguments{
\item{qry}{\if{html}{\out{<complex>}} The query to collect}
\item{geometry_cols}{\if{html}{\out{<character>}} Any geometry columns to translate to sf}
\item{geometry_crs}{\if{html}{\out{<complex>}} The CRS to assign to the columns. Either
specified by the CRS number or an sf::st_crs() object.}
\item{check_ring_dir}{\if{html}{\out{<logical>}} Check the direction of rings during the
translation. See \code{sf::st_as_sfc} for further details.}
}
\value{
\if{html}{\out{<complex>}} The collected query with translated geometry columns
}
\description{
Requires sf package.
Runs dplyr::collect on a query, If there are gemoetry columns (specified by
gemoetry_cols or named geom or named proj) then they are translated into sf
geometry columns using sf::st_as_sfc with a CRS.
The default CRS for a column named \code{geom} is 4326.
The default CRS for a column named \code{proj} is 3035.
The default CRS for other geometry columns is specified by \code{geometry_crs}
}