announce deprecated/renamed functions

close #416

NEWS.md

@@ -34,6 +34,10 @@ These features are not yet on CRAN. Install with `remotes::install_github(repo
 * Better documentation for the server url (suggested by @sutzig #395)
 * `read_read_oneshot()`'s parameter `guess_max` now allows floating point values to support `readr::read_csv()` ability to accept a Inf value. (Suggested by @eveyp, #392)
 * pkgdown pages run & display the examples, but CRAN still doesn't run them. It's illegal to call external resources/APIs from CRAN computers --mostly because they are occasionally unavailable, so the code breaks. (#419)
+* Renamed some functions to follow a consistent pattern. Old names will be soft-deprecated for a while before being removed. (#416)
+ * `redcap_download_file_oneshot()` to `redcap_file_download_opneshot()`
+ * `redcap_file_upload_oneshot()` to `redcap_file_upload_opneshot()`
+ * `redcap_download_instrument()` to `redcap_instrument_download()`
 
 Version 1.1.0 (released 2022-08-10)
 ==========================================================

_pkgdown.yml

@@ -43,17 +43,17 @@ reference:
  - redcap_write_oneshot
  - redcap_delete
  - redcap_report
- - redcap_download_file_oneshot
- - redcap_upload_file_oneshot
+ - redcap_file_download_oneshot
+ - redcap_file_upload_oneshot
 
  - title: "Additional API Methods"
  desc: >
  Accessing other information from the REDCap project or server.
  contents:
  - redcap_arm_export
  - redcap_dag_read
- - redcap_download_instrument
  - redcap_event_instruments
+ - redcap_instrument_download
  - redcap_instruments
  - redcap_log_read
  - redcap_metadata_coltypes
@@ -92,3 +92,11 @@ reference:
  - replace_nas_with_explicit
  - sanitize_token
  - validate
+
+ - title: "Soft Deprecated"
+ desc: >
+ Functions that have been renamed and will be removed in future REDCapR versions.
+ contents:
+ - redcap_download_file_oneshot
+ - redcap_upload_file_oneshot
+ - redcap_download_instrument