Commit e4c0eabb authored by Ahmadou Dicko's avatar Ahmadou Dicko
Browse files

Support page size in kobo_setup and default to 1000

parent fae207e6
Loading
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
Package: robotoolbox
Title: Client for the 'KoboToolbox' API
Version: 1.4.99.9000
Version: 1.5.0
Authors@R: c(person(given = "Ahmadou",
                    family = "Dicko",
		    email = "mail@ahmadoudicko.com",
+1 −1
Original line number Diff line number Diff line
YEAR: 2023
YEAR: 2023-2026
COPYRIGHT HOLDER: Ahmadou Dicko
+3 −0
Original line number Diff line number Diff line
@@ -4,6 +4,7 @@ S3method(kobo_asset,character)
S3method(kobo_asset,default)
S3method(kobo_asset,kobo_asset)
S3method(kobo_asset_file_list,character)
S3method(kobo_asset_file_list,default)
S3method(kobo_asset_file_list,kobo_asset)
S3method(kobo_asset_version,character)
S3method(kobo_asset_version,default)
@@ -12,6 +13,7 @@ S3method(kobo_asset_version_list,character)
S3method(kobo_asset_version_list,default)
S3method(kobo_asset_version_list,kobo_asset)
S3method(kobo_attachment_download,character)
S3method(kobo_attachment_download,default)
S3method(kobo_attachment_download,kobo_asset)
S3method(kobo_audit,character)
S3method(kobo_audit,default)
@@ -105,6 +107,7 @@ importFrom(rlang,abort)
importFrom(rlang,names_inform_repair)
importFrom(rlang,set_names)
importFrom(rlang,squash)
importFrom(rlang,warn)
importFrom(stats,na.omit)
importFrom(stats,setNames)
importFrom(stringi,stri_detect_regex)
+6 −5
Original line number Diff line number Diff line
robotoolbox 1.5 (2026-01-17)
robotoolbox 1.5.0 (2026-03-14)
======================

### BREAKING CHANGES
@@ -33,10 +33,11 @@ robotoolbox 1.5 (2026-01-17)
- Removed deprecated `vcr::check_cassette_names()` from test setup.

### NOTES
- The default `page_size` is now capped at 1,000 for safety on public KoboToolbox servers.
- **Performance tip for private instances:** Users with private servers that allow higher limits
  can explicitly set `page_size` (e.g., `kobo_data(asset, page_size = 30000)`) for significantly
  better performance on large datasets.
- `kobo_setup()` now accepts a `page_size` parameter (default `1000`) to configure the maximum
  number of submissions per API request. Users with private servers that allow higher limits
  can set this to a larger value (e.g., `kobo_setup(..., page_size = 30000)`) to fetch more
  data per request and avoid unnecessary pagination.
- The default `page_size` is capped at 1,000 for safety on public KoboToolbox servers.
- **Known limitation:** `kobo_audit()` and `kobo_attachment_download()` currently fetch
  attachments from the first 1,000 submissions only. Full pagination support for these
  functions is planned for a future release.
+2 −0
Original line number Diff line number Diff line
@@ -216,6 +216,7 @@ print.kobo_asset <- function(x, ...) {
  cat("  Last modified: ",
      parse_kobo_datetime(x$date_modified), "\n", sep = "")
  cat("  Submissions: ", x$deployment__submission_count, "\n", sep = "")
  invisible(x)
}

#' @noRd
@@ -227,4 +228,5 @@ print.kobo_asset_version <- function(x, ...) {
      is.na(as.logical(x$date_deployed)), "\n", sep = "")
  cat("  Date modified: ",
      parse_kobo_datetime(x$date_modified), "\n", sep = "")
  invisible(x)
}
Loading