List of non-public or deprecated functions

[kaydin]

Add functions that may need to be non-public or deprecated

[aw2113]

deprecate rsim.sense.path() and use rsim.sense(() going forward

[aw2113]

I've added @noRd for rsim.sense.rpath() to prevent the .Rd from being generated and hence, remove the documentation. I have left @export in because that way the function is still visible and accessible to the user. However, this arrangement prevents pkgdown::build_site() from rendering. I think this is because rsim.sense.path() is still in the _pkgdown.yml and NAMESPACE. If I remove the @export the function is then no longer accessible to the user.

I think our intention here was to keep the deprecated function available for limited time with a warning and a suggestion to use the new function, but to suppress any documentation for the old function. Any ideas on how to sort this out?

[andybeet]

yeah, that will cause build issues. I think you might still need/want to include the documentation, then add the deprecated badge in the help, in addition to a message when the function is run. But i'll defer to the power users

[aw2113]

Since we can't have our cake and eat it too, I've added documentation for the deprecated function with at warning at the top and a warning when the function runs. However, I did not include an example as the deprecated function no longer appears to work with the current Rpath version. I think I've isolated where the code is hanging up. But if anyone is using this deprecated function, I imagine they are using an older version of Rpath. I could debug and get the function working with the present version but is that something we'd want to do for a deprecated function?

[andybeet]

Agree with you, i feel like we leave as is. not sure want to show how to use a function we no longer want to include.

[aw2113]

After some discussion with @kaydin about the origins of the deprecated sense function, we are going to delete it as a separate pull request.

[aw2113]

Do we want to deprecate a function with .Deprecated() from base R, or with lifestyle::deprecated(), https://r-pkgs.org/lifecycle.html#deprecating-a-function

[andybeet]

i have no experience with either. But the lifestyle package is developed by the rstudio folks. example in dplyr https://dplyr.tidyverse.org/reference/se-deprecated.html?q=do_#ref-usage

I'd vote for that

[aw2113]

Ok, I was going to use the lifestyle package but went with .Deprecated() from base R for now because I wasn't sure if using lifestyle would create an additional dependency for Rpath?

[andybeet]

I think going the route you did is just as good. and yeah, it would create another dependency using lifestyle