add comments, add package, edit docs

DESCRIPTION

@@ -32,6 +32,7 @@ Imports:
     DT,
     rstudioapi (>= 0.7),
     htmltools,
+    here,
     shiny
 Suggests: rmarkdown,
     knitr,

NAMESPACE

@@ -1,4 +1,121 @@
 # Generated by roxygen2: do not edit by hand
 
+export(aci_webservice_deployment_config)
+export(aks_webservice_deployment_config)
+export(attach_aks_compute)
+export(azureml)
+export(bandit_policy)
+export(bayesian_parameter_sampling)
+export(cancel_run)
+export(choice)
+export(complete_run)
+export(container_registry)
+export(create_aks_compute)
+export(create_aml_compute)
+export(create_workspace)
+export(delete_compute)
+export(delete_local_webservice)
+export(delete_model)
+export(delete_secrets)
+export(delete_webservice)
+export(delete_workspace)
+export(deploy_model)
+export(detach_aks_compute)
+export(download_file_from_run)
+export(download_files_from_run)
+export(download_from_datastore)
+export(download_model)
+export(estimator)
+export(experiment)
+export(generate_new_webservice_key)
+export(get_aks_compute_credentials)
+export(get_best_run_by_primary_metric)
+export(get_child_run_hyperparameters)
+export(get_child_run_metrics)
+export(get_child_runs_sorted_by_primary_metric)
+export(get_compute)
+export(get_current_run)
+export(get_datastore)
+export(get_default_datastore)
+export(get_default_keyvault)
+export(get_environment)
+export(get_model)
+export(get_model_package_container_registry)
+export(get_model_package_creation_logs)
+export(get_run)
+export(get_run_details)
+export(get_run_details_with_logs)
+export(get_run_file_names)
+export(get_run_metrics)
+export(get_runs_in_experiment)
+export(get_secrets)
+export(get_secrets_from_run)
+export(get_webservice)
+export(get_webservice_keys)
+export(get_webservice_logs)
+export(get_webservice_token)
+export(get_workspace)
+export(get_workspace_details)
+export(grid_parameter_sampling)
+export(hyperdrive_config)
+export(inference_config)
+export(install_azureml)
+export(invoke_webservice)
+export(list_nodes_in_aml_compute)
+export(list_secrets)
+export(list_supported_vm_sizes)
+export(list_workspaces)
+export(load_workspace_from_config)
+export(local_webservice_deployment_config)
+export(log_accuracy_table_to_run)
+export(log_confusion_matrix_to_run)
+export(log_image_to_run)
+export(log_list_to_run)
+export(log_metric_to_run)
+export(log_predictions_to_run)
+export(log_residuals_to_run)
+export(log_row_to_run)
+export(log_table_to_run)
+export(lognormal)
+export(loguniform)
+export(median_stopping_policy)
+export(normal)
+export(package_model)
+export(primary_metric_goal)
+export(pull_model_package_image)
+export(qlognormal)
+export(qloguniform)
+export(qnormal)
+export(quniform)
+export(r_environment)
+export(randint)
+export(random_parameter_sampling)
+export(register_azure_blob_container_datastore)
+export(register_azure_file_share_datastore)
+export(register_environment)
+export(register_model)
+export(reload_local_webservice_assets)
+export(save_model_package_files)
+export(set_default_datastore)
+export(set_secrets)
+export(start_logging_run)
+export(submit_experiment)
+export(truncation_selection_policy)
+export(uniform)
+export(unregister_datastore)
+export(update_aci_webservice)
+export(update_aks_webservice)
+export(update_aml_compute)
+export(update_local_webservice)
+export(upload_files_to_datastore)
+export(upload_files_to_run)
+export(upload_folder_to_run)
+export(upload_to_datastore)
+export(view_run_details)
+export(wait_for_deployment)
+export(wait_for_model_package_creation)
+export(wait_for_provisioning_completion)
+export(wait_for_run_completion)
+export(write_workspace_config)
 importFrom(reticulate,import)
 importFrom(reticulate,py_str)

R/run.R

@@ -536,7 +536,6 @@ log_table_to_run <- function(name, value, description = "", run = NULL) {
 
 #' Generate table of run details
 #' @param run The `Run` object.
-#' @export
 #' @md
 create_run_details_plot <- function(run) {
   handle_null <- function(arg, placeholder = "-") {
@@ -629,20 +628,20 @@ create_run_details_plot <- function(run) {
 #' Initialize run details widget
 #' @description
 #' Plot table of run details in RStudio Viewer or browser.
-#' By default, this table does not auto-refresh. To see stream
-#' live updates from the server, click the "Turn on auto-update"
-#' box in the top left corner of the widget. For more details,
-#' click the web view link.
+#' If in RStudio, plot will update table values regularly. If not using
+#' RStudio, the plot will be static. For more details than provided in the
+#' plot, click the web view link.
 #'
 #' If you are running this method from an RMarkdown file, the
 #' run details table will show up in the code chunk output
 #' instead of the Viewer.
 #' @param run Run object
 #' @export
-view_run_details <- function(run, auto_refresh = TRUE) {
+#' @md
+view_run_details <- function(run) {
   run_details_plot <- create_run_details_plot(run)
 
-  if (rstudioapi::isAvailable() && auto_refresh) {
+  if (rstudioapi::isAvailable()) {
     parsed_url <- strsplit(run$get_portal_url(), "/")[[1]]
 
     assign("rg", parsed_url[8], envir = globalenv())

man/view_run_details.Rd

@@ -11,10 +11,9 @@ view_run_details(run)
 }
 \description{
 Plot table of run details in RStudio Viewer or browser.
-By default, this table does not auto-refresh. To see stream
-live updates from the server, click the "Turn on auto-update"
-box in the top left corner of the widget. For more details,
-click the web view link.
+If in RStudio, plot will update table values regularly. If not using
+RStudio, the plot will be static. For more details than provided in the
+plot, click the web view link.
 
 If you are running this method from an RMarkdown file, the
 run details table will show up in the code chunk output