Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve error around the repo_name argument in support_panel() #29

Merged
merged 3 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions R/support_panel.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@
#' Create the standard DfE R-Shiny support and feedback dashboard panel.
#'
#' @param team_email Your team e-mail address, must be a education.gov.uk email
#' @param repo_name The repository name as listed on GitHub
#' @param repo_name The repository URL, must be a valid URL for the
#' dfe-analytical-services GitHub area
#' @param ees_publication Whether the parent publication is hosted on Explore
#' Education Statistics
#' @param publication_name The parent publication name
#' @param publication_slug The parent publication slug on Explore Education
#' Statistics
#' @param alt_href Alternative link to the parent publication (if not hosted on
#' Explore Education Statistics)
#' @param form_url URL to a feedback form for the dashboard
#' @param form_url URL for a feedback form for the dashboard
#' @param cookie_status_output Name of cookie status output object, often
#' "cookie_status"
#'
Expand Down Expand Up @@ -71,8 +72,10 @@

if (is_valid_repo_name(repo_name) == FALSE) {
stop(
"Please ensure the repo_name argument points to a repository on the
dfe-analytical-services GitHub area."
"Please ensure the repo_name argument is a valid URL for a repository on
the dfe-analytical-services GitHub area. For example:
repo_name = 'https://github.com/dfe-analytical-services/dfeR'.
"
)
}

Expand Down Expand Up @@ -126,8 +129,7 @@
is available at the following link: ",
shiny::tags$a(
href = paste0(
"https://explore-education-statistics.service.gov.uk/
find-statistics/",
"https://explore-education-statistics.service.gov.uk/find-statistics/",
Dismissed Show dismissed Hide dismissed
publication_slug
),
ifelse(
Expand All @@ -140,18 +142,16 @@
". The statistical release provides additional ",
shiny::tags$a(
href = paste0(
"https://explore-education-statistics.service.gov.uk/
find-statistics/",
publication_slug, "/data guidance"
"https://explore-education-statistics.service.gov.uk/find-statistics/",
Dismissed Show dismissed Hide dismissed
publication_slug, "/data-guidance"
),
"data guidance",
.noWS = c("after")
),
" and ",
shiny::tags$a(
href = paste0(
"https://explore-education-statistics.service.gov.uk/
find-statistics/",
"https://explore-education-statistics.service.gov.uk/find-statistics/",
Dismissed Show dismissed Hide dismissed
publication_slug, "#explore-data-and-files"
),
"tools to access and interogate the underling data",
Expand Down
5 changes: 3 additions & 2 deletions man/support_panel.Rd

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

Loading