Merge pull request #53 from hubverse-org/hotfix/zoltr-dep

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: hubData
 Title: Tools for accessing and working with hubverse data
-Version: 1.2.0
+Version: 1.2.1
 Authors@R: 
     c(person("Anna", "Krystalli", , "annakrystalli@googlemail.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-2378-4915")),
@@ -48,7 +48,6 @@ Suggests:
     testthat (>= 3.2.0)
 Remotes:
     hubverse-org/hubUtils,
-    reichlab/zoltr,
     apache/arrow/r@apache-arrow-15.0.2
 Config/Needs/website: hubverse-org/hubStyle
 Depends: 

NEWS.md

@@ -1,3 +1,8 @@
+# hubData 1.2.1
+
+* Removed dependency on development version of `zoltr` package.
+* Fixed minor error in `connect_hub()` article.
+
 # hubData 1.2.0
 
 * Adds a `skip_checks` parameter to the `connect_hub` and `connect_model_output` functions. When `skip_checks` is set to `TRUE`, these functions will bypass the default behavior of scanning the hub's model output directory for invalid files. Omitting these checks results in better performance when connecting to cloud-based hubs but can result in errors when querying the data. This option is only valid when connecting to hubs that meet the following criteria:

R/connect_hub.R

@@ -25,12 +25,14 @@
 #' `admin.json` and is ignored by default.
 #' If supplied, it will override hub configuration setting. Multiple formats can
 #' be supplied to `connect_hub` but only a single file format can be supplied to `connect_mod_out`.
-#' @param skip_checks Logical. If `FALSE` (default), check file_format parameter against the
-#' hub's model output files. Also excludes invalid model output files when opening hub datasets.
-#' Setting to `TRUE`` will improve performance but will result in an error if the model output
-#' directory includes invalid files. Cannot be `TRUE` when there are multiple file formats in
-#' the hub's model output directory or when the hub's model output directory contains files that
-#' are not model output data (for example, a README).
+#' @param skip_checks Logical. If `FALSE` (default), check `file_format` parameter
+#' against the hub's model output files. Also excludes invalid model output files
+#'  when opening hub datasets.
+#' Setting to `TRUE` will improve performance but will result in an error if
+#' the model output directory includes invalid files. **Cannot be `TRUE`** when
+#' there are **multiple file formats** in the hub's model output directory or when
+#' the hub's model output directory contains **files that are not model output
+#' data** (for example, a README).
 #' @inheritParams create_hub_schema
 #'
 #' @return

vignettes/articles/connect_hub.Rmd

@@ -224,7 +224,7 @@ Like `connect_hub`, `connect_model_output` has an optional `skip_checks` argumen
 
 ```{r}
 mod_out_dir_cloud <- s3_bucket("hubverse/hubutils/testhubs/parquet/model-output/")
-mod_out_con_cloud <- connect_hub(mod_out_dir_cloud, file_format = "parquet", skip_checks = TRUE)
+mod_out_con_cloud <- connect_model_output(mod_out_dir_cloud, file_format = "parquet", skip_checks = TRUE)
 mod_out_con_cloud
 ```