Skip to content

Commit

Permalink
Update and render Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexAxthelm committed Dec 13, 2024
1 parent a426a64 commit c0c6807
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 6 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Generated by roxygen2: do not edit by hand

export(run_dashboard_workflow)
importFrom(dplyr,across)
importFrom(dplyr,all_of)
importFrom(dplyr,arrange)
Expand Down
9 changes: 3 additions & 6 deletions R/run_dashboard_workflow.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,13 @@
#' dashboard process. See JSON Schema for details.
#' @param raw_params (`character`) Raw JSON string of parameters.
#' @param run_analysis (`logical`) Run the analysis process.
#' @param run_dashboard (`logical`) Run the dashboard creation process.
#' @param analysis_output_dir Directory containing the PACTA analysis results.
#' @param benchmarks_dir Directory containing the benchmark analysis results.
#' @param benchmarks_dir filepath: Directory containing the benchmark analysis
#' results.
#' @param pacta_data_dir filepath: Directory with "pacta-data"
#' @param portfolio_dir filepath: Directory with portfolio files
#' @param real_estate_dir Directory containing real estate data.
#' @param dashboard_output_dir Directory where the dashboard will be
#' @param score_card_dir Directory containing score card data.
#' @param summary_output_dir Directory where the executive summary will be
#' @param survey_dir Directory containing survey data.
#' saved.
#' saved.
#' @return (invisible) `TRUE` if the workflow was successful. Primarily called
#' for side effect of rendering files.
Expand Down
47 changes: 47 additions & 0 deletions man/run_dashboard_workflow.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c0c6807

Please sign in to comment.