[porterhyphenborden]

Deprecates broken functions and updates documentation.

Some functions (search/discover) in this package are broken/calling endpoints that do not exist. The methods of the client HSClient are almost entirely broken as well (does not correctly handle API responses) so have deprecated that entire thing.

To test:

• Clone this repo
• git fetch origin
• git checkout --track origin/6524-deprecate-broken-functions
• R to start R session
• In session:
  • install.packages(c("devtools", "remotes"))
  • remotes::install_deps(dependencies = TRUE)
  • devtools::load_all(".")
  • hs_search(text = "test")
  • hs_discover()
  • HSClient$new()

Should see the deprecation warning for these 3 calls.

Note: CI checks are failing with:

Error: This request has been automatically failed because it uses a deprecated version of `actions/cache: v2`. Please update your workflow to use v3/v4 of actions/cache to avoid interruptions. Learn more: https://github.blog/changelog/2024-12-05-notice-of-upcoming-releases-and-breaking-changes-for-github-actions/#actions-cache-v1-v2-and-actions-toolkit-cache-package-closing-down

I am not going to update the actions at this time since we are not planning to develop this currently.