From 844d06a625e62753be26213f5c9f302fce84dc87 Mon Sep 17 00:00:00 2001 From: mkoohafkan Date: Wed, 27 Dec 2023 21:47:10 -0800 Subject: [PATCH] updated docs and badges --- .github/workflows/pkgdown.yaml | 2 ++ DESCRIPTION | 2 +- R/connect.r | 3 +-- README.md | 4 +++- man/create.Rd | 8 ++++---- man/drop.Rd | 10 +++++----- man/hdfqlr.Rd | 7 +++++++ man/hql_create.Rd | 6 +++--- man/hql_file.Rd | 6 +++--- man/hql_list.Rd | 8 ++++---- man/hql_load.Rd | 4 ++-- man/hql_read.Rd | 8 ++++---- man/hql_write.Rd | 8 ++++---- 13 files changed, 43 insertions(+), 33 deletions(-) diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index 087f0b0..ed7650c 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -19,6 +19,8 @@ jobs: group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} env: GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + permissions: + contents: write steps: - uses: actions/checkout@v3 diff --git a/DESCRIPTION b/DESCRIPTION index 6b73343..b2f2735 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -21,7 +21,7 @@ Suggests: SystemRequirements: HDFql (>= 2.1.0) License: GPL (>= 3) Encoding: UTF-8 -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.3 Roxygen: list(markdown = TRUE) VignetteBuilder: knitr URL: http://hydroecology.net/hdfqlr/ diff --git a/R/connect.r b/R/connect.r index 88630eb..97f1d16 100644 --- a/R/connect.r +++ b/R/connect.r @@ -85,8 +85,7 @@ set_paths = function() { "wrapper/R/libHDFqlR.so" ) hdfql_shared_library = "libHDFqlR" - } else # macOS - { + } else { # macOS lib.names = c( "lib/libHDFql.dylib", "wrapper/R/libHDFqlR.dylib" diff --git a/README.md b/README.md index 456b726..e172935 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # hdfqlr -![CRAN Release](https://www.r-pkg.org/badges/version-last-release/hdfqlr) +[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/hdfqlr)](http://cran.r-project.org/package=hdfqlr) +[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![R-CMD-check](https://github.com/mkoohafkan/hdfqlr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mkoohafkan/hdfqlr/actions/workflows/R-CMD-check.yaml) +[![CRAN_Download_Badge](https://cranlogs.r-pkg.org/badges/grand-total/hdfqlr)](http://cran.r-project.org/package=hdfqlr) The `hdfqlr` package for R provides an API for HDF file access using diff --git a/man/create.Rd b/man/create.Rd index e55fb1e..e18f48c 100644 --- a/man/create.Rd +++ b/man/create.Rd @@ -61,11 +61,11 @@ Generic helper for creating HDF objects. } \section{Functions}{ \itemize{ -\item \code{create_group}: Create HDF group. +\item \code{create_group()}: Create HDF group. -\item \code{create_dataset}: Create HDF dataset. +\item \code{create_dataset()}: Create HDF dataset. -\item \code{create_attribute}: Create HDF attribute. -}} +\item \code{create_attribute()}: Create HDF attribute. +}} \keyword{internal} diff --git a/man/drop.Rd b/man/drop.Rd index 3e64257..e472502 100644 --- a/man/drop.Rd +++ b/man/drop.Rd @@ -34,13 +34,13 @@ Drop HDF objects. } \section{Functions}{ \itemize{ -\item \code{hql_drop_dataset}: Drop HDF dataset. +\item \code{hql_drop_dataset()}: Drop HDF dataset. -\item \code{hql_drop_group}: Drop HDF group. +\item \code{hql_drop_group()}: Drop HDF group. -\item \code{hql_drop_attribute}: Drop HDF attribute. +\item \code{hql_drop_attribute()}: Drop HDF attribute. -\item \code{hql_drop_all_attributes}: Drop all attributes from an HDF dataset or group. -}} +\item \code{hql_drop_all_attributes()}: Drop all attributes from an HDF dataset or group. +}} \keyword{internal} diff --git a/man/hdfqlr.Rd b/man/hdfqlr.Rd index edc87ee..7d4fb5c 100644 --- a/man/hdfqlr.Rd +++ b/man/hdfqlr.Rd @@ -21,6 +21,13 @@ Alternatively, the HDFql install directory can be saved to an environment variable \code{HDFQL_DIR}. } +\seealso{ +Useful links: +\itemize{ + \item \url{http://hydroecology.net/hdfqlr/} +} + +} \author{ \strong{Maintainer}: Michael Koohafkan \email{michael.koohafkan@gmail.com} diff --git a/man/hql_create.Rd b/man/hql_create.Rd index 1b8db91..7fe9c49 100644 --- a/man/hql_create.Rd +++ b/man/hql_create.Rd @@ -25,11 +25,11 @@ Create HDF files and groups. } \section{Functions}{ \itemize{ -\item \code{hql_create_file}: Create HDF file. +\item \code{hql_create_file()}: Create HDF file. -\item \code{hql_create_group}: Create HDF group. -}} +\item \code{hql_create_group()}: Create HDF group. +}} \examples{ if(hql_is_loaded()) { tf = tempfile(fileext = ".h5") diff --git a/man/hql_file.Rd b/man/hql_file.Rd index bc4e244..aedb9a0 100644 --- a/man/hql_file.Rd +++ b/man/hql_file.Rd @@ -20,11 +20,11 @@ Open (use) and close HDF files. } \section{Functions}{ \itemize{ -\item \code{hql_use_file}: Open (use) an HDF file. +\item \code{hql_use_file()}: Open (use) an HDF file. -\item \code{hql_close_file}: Close an HDF file. -}} +\item \code{hql_close_file()}: Close an HDF file. +}} \examples{ if(hql_is_loaded()){ tf = tempfile(fileext = ".h5") diff --git a/man/hql_list.Rd b/man/hql_list.Rd index 36c82f2..7f45e32 100644 --- a/man/hql_list.Rd +++ b/man/hql_list.Rd @@ -27,10 +27,10 @@ List groups, datasets or attribute in an HDF file. } \section{Functions}{ \itemize{ -\item \code{hql_list_groups}: List groups. +\item \code{hql_list_groups()}: List groups. -\item \code{hql_list_datasets}: List datasets. +\item \code{hql_list_datasets()}: List datasets. -\item \code{hql_list_attributes}: List Attributes -}} +\item \code{hql_list_attributes()}: List Attributes +}} diff --git a/man/hql_load.Rd b/man/hql_load.Rd index 6648c4a..d19b237 100644 --- a/man/hql_load.Rd +++ b/man/hql_load.Rd @@ -17,6 +17,6 @@ Load the HDFql library. } \section{Functions}{ \itemize{ -\item \code{hql_unload}: Unload HDFql Library. -}} +\item \code{hql_unload()}: Unload HDFql Library. +}} diff --git a/man/hql_read.Rd b/man/hql_read.Rd index c656666..c11f0af 100644 --- a/man/hql_read.Rd +++ b/man/hql_read.Rd @@ -36,13 +36,13 @@ Generic helper for reading HDF objects into memory. } \section{Functions}{ \itemize{ -\item \code{hql_read_dataset}: Read a dataset from an HDF file. +\item \code{hql_read_dataset()}: Read a dataset from an HDF file. -\item \code{hql_read_attribute}: Read a single attribute from an HDF file. +\item \code{hql_read_attribute()}: Read a single attribute from an HDF file. -\item \code{hql_read_all_attributes}: Read attributes from an HDF file. -}} +\item \code{hql_read_all_attributes()}: Read attributes from an HDF file. +}} \examples{ if(hql_is_loaded()){ tf = tempfile(fileext = ".h5") diff --git a/man/hql_write.Rd b/man/hql_write.Rd index a7dd0f8..5328be7 100644 --- a/man/hql_write.Rd +++ b/man/hql_write.Rd @@ -40,13 +40,13 @@ Write a dataset or attribute to an HDF file. } \section{Functions}{ \itemize{ -\item \code{hql_write_dataset}: Write a dataset to an HDF file. +\item \code{hql_write_dataset()}: Write a dataset to an HDF file. -\item \code{hql_write_attribute}: Write an attribute to an HDF file. +\item \code{hql_write_attribute()}: Write an attribute to an HDF file. -\item \code{hql_write_all_attributes}: Write multiple attributes to an HDF file. -}} +\item \code{hql_write_all_attributes()}: Write multiple attributes to an HDF file. +}} \examples{ if(hql_is_loaded()){ tf = tempfile(fileext = ".h5")