{connectViz} offers a collection of helper functions and 'htmlwidgets' to help admins or user better understand how 'RStudio Connect' is used in their organisation. The package provides plug and play visualisations that can be customised depending on needs.
This might be obvious if one interacts often with RSC and similar tools, but I think the requirement of an API key stored in an env var should be added to the README and the vignette.
Currently users will first run into the error in
create_rsc_client()
and then need to look up the help page.
You might also want to clarify the wording a bit on
Expect to have Sys.getenv("CONNECT_SERVER") and Sys.getenv("CONNECT_API_KEY") properly setup.
I.e. I think stating something like "the RSC address needs to available via an env var CONNECT_SERVER. Also an API must be stored in env var CONNECT_API_KEY" might eventually be more clear.
Sys.getenv() is only the query fun and it sounds a bit unusual to use them in this context.
This might be obvious if one interacts often with RSC and similar tools, but I think the requirement of an API key stored in an env var should be added to the README and the vignette.
Currently users will first run into the error in
and then need to look up the help page.
You might also want to clarify the wording a bit on
I.e. I think stating something like "the RSC address needs to available via an env var
CONNECT_SERVER. Also an API must be stored in env varCONNECT_API_KEY" might eventually be more clear.Sys.getenv()is only the query fun and it sounds a bit unusual to use them in this context.