From 7b4559c262db5d883bf94f9cce85d30e58446f89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Fri, 9 Feb 2024 08:54:03 +0100 Subject: [PATCH] docs: update package-level manual page --- R/duckdb.R | 12 ++---------- _pkgdown.yml | 3 --- man/duckdb-package.Rd | 15 +++++++++++---- man/figures/logo | Bin 2749 -> 0 bytes 4 files changed, 13 insertions(+), 17 deletions(-) delete mode 100644 man/figures/logo diff --git a/R/duckdb.R b/R/duckdb.R index b506847da..38c8f5ab6 100644 --- a/R/duckdb.R +++ b/R/duckdb.R @@ -1,15 +1,7 @@ -#' DuckDB client package for R -#' -#' R client package for DuckDB: an embeddable SQL OLAP Database Management System. -#' -#' @seealso -#' [duckdb()] for connection instructions. -#' -#' for the project website. -#' ## usethis namespace: start #' @useDynLib duckdb, .registration = TRUE ## usethis namespace: end -#' @docType package #' @name duckdb-package +#' @keywords internal +"_PACKAGE" NULL diff --git a/_pkgdown.yml b/_pkgdown.yml index e079f8852..f6489e9d3 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -31,6 +31,3 @@ reference: - duckdb_prepare_substrait - duckdb_prepare_substrait_json - duckdb_explain-class -- title: internal - contents: - - duckdb-package diff --git a/man/duckdb-package.Rd b/man/duckdb-package.Rd index 6d23aa728..d6d2ac186 100644 --- a/man/duckdb-package.Rd +++ b/man/duckdb-package.Rd @@ -3,14 +3,20 @@ \docType{package} \name{duckdb-package} \alias{duckdb-package} -\title{DuckDB client package for R} +\title{duckdb: DBI Package for the DuckDB Database Management System} \description{ -R client package for DuckDB: an embeddable SQL OLAP Database Management System. +\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} + +The DuckDB project is an embedded analytical data management system with support for the Structured Query Language (SQL). This package includes all of DuckDB and a R Database Interface (DBI) connector. } \seealso{ -\code{\link[=duckdb]{duckdb()}} for connection instructions. +Useful links: +\itemize{ + \item \url{https://r.duckdb.org/} + \item \url{https://github.com/duckdb/duckdb-r} + \item Report bugs at \url{https://github.com/duckdb/duckdb-r/issues} +} -\url{https://duckdb.org/} for the project website. } \author{ \strong{Maintainer}: Hannes Mühleisen \email{hannes@cwi.nl} (\href{https://orcid.org/0000-0001-8552-0029}{ORCID}) @@ -49,3 +55,4 @@ Other contributors: } } +\keyword{internal} diff --git a/man/figures/logo b/man/figures/logo deleted file mode 100644 index 41c2024e2561428bd859a5b57ccb5b7f4df5b587..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2749 zcmc(dcTm%58pnU31rSg|mnI<61JaAY5*HMZ%n z9RLsr06=>O*c}9p1A+nqU;%zXFc>T(Bq%H*DJrsWpNJepV!x!~L1iVyg9-|V4ns8# zsp_gJC}^5#=^7k0Ha1q)u&_2aJO(u~HvH2BBqSsxvQI=-R8-bbMM1^zzpmZafVd#A z3@r14Q~@4w5U)6Bw;oW~3(3O^`ZMoe1rp@r2lEK(#S=W69f#e(iVUETxhax1(wMEHX;aQl*xv=<-ZC}R-a(QJ(iQebA z%T!GDpp|Lntg{>zZW0y=sV28KqoVC>{jm30;}82nN4k4ES?bcoC3UYS9Pmo-6Z1!L zrjpb}48wA*yb48#!B%?fMm(v9BzfJi zGTJxjf~Vg6fLrF7m9(Ei$7((c2Aq4vh9_{?4)|pmcq&(KKB#luh%ilEL?K43eA4n~ z-MCidE+%r4Mc8-e+_VG7y|#%cOzuY9Lkh8(qw#&4a~P1-fge$UATV{Q>+{9jm)QYN z!$qgd81wB{&3E)?0!-S!Xm-rGScev^^VgUT8YIfDFr$D%@-Xm2*N|V_u+3u%tuwwD*$oeNeG39N& zd%Hj|VlB@s%$`0_z1Hh~^ylzsY~!7zVnTBpnMr1VIMR_c_Wh52Yk_Pv}wsp6>4+yshbM zblwNi?W8T4!6Em9-ZsL~MHfphyQCCIQO|~&7jR6vY|5QKQCj;iT`jI5HFw_|hEE4` ziG$zKS?Sf%lv+K%Ky8$_)d_3MUo=?;WxGJLZXD_NIR|VL&Sna|($cxNub#G+RIT1T zOA}R+@B=o>rmsd`a@F>NLhRF8D&a!`+7(TH_dD{rCNj$_nGGZ2QnPX6D3)CWg(e1L zTU|ynh=bK(R~87ypAm3^G@RIDr<;I}`UV1k&>xw~7*T6-Lc!D`xFNa`llyc1sZ)rD z^sV_ek&`$j^(6Ct6R&Ko z^Lp;AlfW^d@74#lW#yjV3_Wc%zipfcOC&XQ1s?o}t0B@90u3aWsrd}%WNKl`j)9+& z!--p%Hn_X=M7PvHu2xzs*|nR3%zv_o#Q6_W#g};dP!f8+=+YY!uOI7L(yu8j77yc9axpv zIDtuxaM<`7@CV#2$}+=A@vt|nr4qb9q`13iddMSTOm;`7i7{pv-TWl;@yuvV)677S zxvWPSCq^e^#oedd>JK1VI{q6IzFdKi*N!B1(bg(+bK+d+$k7rnrBtg}oqF1pg)q`V#7T<3cqL)Hx6W~q36Uo>YXrP5n9+ku@Gd3}g>r%qv-#pp)l5NUeL7{T z@`I22-nN_%T<($54_;J(-IV4uuP*Bz>83>IpQaeh1o%Gt=$xE_-I z$$N&bd~6qx(}(+W z!pOm#;3DnHD&qiTh87H4=#OW3G73%U^3~c|(E&ti!KjdN5H?^K1$T^!i`jtTI!+jl{)??E=qsunngj!po>x9Q<1fRI;~z;vm6u+Qhz- zlKcv1n@1)SW_gz@60DV-+>b6bk1Uw22Lc|;0Hecp9gri F{~sLIiHHCI