Use redquack for REDCap API, add parameters to import_instruments(), add codebook functions, and update to 1.2.0

[dylanpieper]

💥 tidyREDCap gains a big data friendly duckdb backend! 💥

This PR introduces version 1.2.0 with major updates to import_instruments() and new codebook functions:

• Change import package to redquack (https://github.com/dylanpieper/redquack)
• Migrate to labelled package for column labels (fixes consider replacing {labelVector} with the {labelled} package #75)
• Add codebook functions (fixes Handle redcap labels #66):
  • codebook() function to access metadata from imported data
  • codebook_convert() to convert coded values to their labeled equivalents
• Also fixes import_instruments fail after dplyr #67

Adds parameters to import_instruments():

• filter_instrument and filter_function for lazy data filtering
• return_list for returning a list of instrument data.frames
• labels for adding/removing column labels

Currently, you need to install the dev version of redquack: pak::pak("dylanpieper/redquack").

Todos

• Document in roxygen and examples
• Document in description, readme, vignettes, and news
• Add/update unit tests
• Merge updates with Update useAPI.Rmd #74
• Submit redquack updates to CRAN

[dylanpieper]

@RaymondBalise: I updated the PR with substantive changes that should fix a few additional issues, and I made some heavy handed edits to the docs. For example, the REDCap instance for the nacho anxiety examples did not work for me, and it made more sense for me to use the University of Oklahoma's instance, as it's used in the tests. Let me know if you have any concerns, and when you might have time to review.

[dylanpieper]

🤖 Claude's summary of additional changes:

Functionality:

• Two-step filtering process: filter one instrument to get record IDs, then apply those IDs to filter all other instruments
• Memory management includes informative messaging for large projects (25M+ and 100M+ data elements)
• drop_label() function now supports multiple variables and tidyselect syntax (e.g., drop_label(df, starts_with("redcap_")))
• Updated all label handling to use modern labelled package methods instead of deprecated labelVector

Testing & Documentation:

• Refreshed all vignette example data and improved practical filtering examples
• Updated security recommendations to include keyring package for encrypted token storage
• Added extensive test suite covering all new parameter combinations and edge cases
• Added Dylan Pieper as package author for his contributions

These improvements make the package significantly more robust for production use with large REDCap projects.

[dylanpieper]

Added error catching to import functions.
Also fixed bugs in #50 and #68.

Happy to split these into multiple PRs too when we are ready to implement.

[RaymondBalise]

I will be at REDCapConf next week and then I will be recording some videos. After that I will return to this. Ray From: Dylan Pieper ***@***.***> Date: Wednesday, September 10, 2025 at 9:29 AM To: RaymondBalise/tidyREDCap ***@***.***> Cc: Balise, Raymond R, Ph.D. ***@***.***>, Mention ***@***.***> Subject: [EXTERNAL] Re: [RaymondBalise/tidyREDCap] Use redquack for REDCap API, add parameters to `import_instruments()`, add codebook functions, and update to 1.2.0 (PR #76) CAUTION: This email originated from outside the organization. DO NOT CLICK ON LINKS or OPEN ATTACHMENTS unless you know and trust the sender. [Image removed by sender.]dylanpieper left a comment (RaymondBalise/tidyREDCap#76)<https://urldefense.com/v3/__https:/github.com/RaymondBalise/tidyREDCap/pull/76*issuecomment-3274992818__;Iw!!KVu0SnhVq1hAFvslES2Y!LFUG5aXSjM5Jj5OBWD9NAn0ytL8r2_QjfXbtNr5TtLETRBcFLka0tHKTEsESt3FA33E4GhrvobvdaYG4SRJBGhU$> Added error catching to import functions. Also fixed bugs in #50<https://urldefense.com/v3/__https:/github.com/RaymondBalise/tidyREDCap/issues/50__;!!KVu0SnhVq1hAFvslES2Y!LFUG5aXSjM5Jj5OBWD9NAn0ytL8r2_QjfXbtNr5TtLETRBcFLka0tHKTEsESt3FA33E4GhrvobvdaYG4EqA1CQU$> and #68<https://urldefense.com/v3/__https:/github.com/RaymondBalise/tidyREDCap/issues/68__;!!KVu0SnhVq1hAFvslES2Y!LFUG5aXSjM5Jj5OBWD9NAn0ytL8r2_QjfXbtNr5TtLETRBcFLka0tHKTEsESt3FA33E4GhrvobvdaYG40stc-mc$>. Happy to split these into multiple PRs too when we are ready to implement. — Reply to this email directly, view it on GitHub<https://urldefense.com/v3/__https:/github.com/RaymondBalise/tidyREDCap/pull/76*issuecomment-3274992818__;Iw!!KVu0SnhVq1hAFvslES2Y!LFUG5aXSjM5Jj5OBWD9NAn0ytL8r2_QjfXbtNr5TtLETRBcFLka0tHKTEsESt3FA33E4GhrvobvdaYG4SRJBGhU$>, or unsubscribe<https://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/AEKOXOTNFLDZZCTFGXPDVKT3SARUZAVCNFSM6AAAAACEB5T22SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTENZUHE4TEOBRHA__;!!KVu0SnhVq1hAFvslES2Y!LFUG5aXSjM5Jj5OBWD9NAn0ytL8r2_QjfXbtNr5TtLETRBcFLka0tHKTEsESt3FA33E4GhrvobvdaYG4zAIiLYI$>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[dylanpieper]

@RaymondBalise Have fun at REDCapConf! After next week, I'll be out until Oct 6th for my wedding / honeymoon!

I think we should hold off on this PR until I get some functions sorted for redquack's redcap_to_db(). They include tidying the collected data format (i.e., single df, list, and assign to global env) and column and coded value labeling and conversion (by reading metadata using httr2 and storing it in the temporary database). This should streamline a lot of the code for an improved import_instruments() and remove the dependency on REDCapR.

Feel free to browse what I have done here, but we should break up this work into smaller PRs.