bcgov / bcsapps

Create a shiny app project using BCStats standards

bcsapps

This package was developed to simplify shiny app development at BCStats. It uses bcgovr::create_bcgov_project() to set up an RProject with all the files necessary to comply with bcgov standards and then also adds in the files needed for a basic BCStats shiny app.

Using this package for initializing shiny apps will also ensure consistency across BCStats’ apps

Features

Functions

create_bcstats_app() Create a new shiny web application project with folders and files to meet both the bcgov standards (utilizing bcgovr) and the BCStats standards for shiny apps.

Modules

bcsHeaderUI() and bcsHeaderServer() Add the standard BCStats header to your app. An appname is required in bcsHeaderUI() for the title to be included in the header. To exclude the drop down list of links to other BCStats apps (kept up to date in bcstatslinks), use bcsHeaderServer(links = FALSE) the default is TRUE.

bcsFooterUI() and bcsFooterServer Add the standard BCStats footer to your app.

Note that create_bcstats_app() generates a basic app.R file with these modules already included.

Installation

This package relies on the bcgovr and bcstatslinks packages, so they need to be installed first. To install packages from github, use the remotes package

## install dependencies
install.packages("remotes")
remotes::install_github("bcgov/bcgovr")
remotes::install_github("bcgov/bcstatslinks")

## install package
remotes::install_github("bcgov/bcsapps")

## load package
library(bcsapps)

Usage

Use this package in combination with the bcgovr package.

1. To start, open RStudio and ensure the working directory is the folder you wish to set up the RProject in (Alternately, you can provide a path to create_bcstats_app())
2. Run create_bcstats_app(coc_email = "<insert email address to be used in the code of conduct file>")
3. Run bcgovr::use_bcgov_git(coc_email = "<insert email address to be used in the code of conduct file>") to initialize git version control
4. Run bcgovr::use_bcgov_github(coc_email = "<insert email address to be used in the code of conduct file>") to open a bcgov GitHub repository

Note, to avoid typing in your email several times it is recommended to add an option to your .Rprofile. You can easily edit your .Rprofile with usethis::edit_r_profile() and then add in the line options(“bcgovr.coc.email” = “[email protected]”. This will edit (and create if necessary) the .Rprofile file under C:/Users/. If you have settings in .Rprofile on C:/Program Files/R/ they will continue to be used at startup as well.

Once your github project is initialized, add in the citz and bcstats topics by clicking the settings “gear” icon next to About on the right panel on GitHub.

To change the name of your “master” branch to “main”:

1. Go to Settings -> Branches on GitHub and edit the name of your default branch
2. In RStudio click Pull on the Git tab to pull in the new branch
3. Click on the drop down that says “master” and switch to the branch (REMOTE:ORIGIN) main

Project Status

Experimental

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

How to Contribute

If you would like to contribute to the package, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Copyright 2021 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.

---

This project was created using the bcgovr package.

bcsapps's Issues

Lets use common phrasing

TL;DR 🏎️

Teams are encouraged to favour modern inclusive phrasing both in their communication as well as in any source checked into their repositories. You'll find a table at the end of this text with preferred phrasing to socialize with your team.

Words Matter

We're aligning our development community to favour inclusive phrasing for common technical expressions. There is a table below that outlines the phrases that are being retired along with the preferred alternatives.

During your team scrum, technical meetings, documentation, the code you write, etc. use the inclusive phrasing from the table below. That's it - it really is that easy.

For the curious mind, the Public Service Agency (PSA) has published a guide describing how Words Matter in our daily communication. Its an insightful read and a good reminder to be curious and open minded.

What about the master branch?

The word "master" is not inherently bad or non-inclusive. For example people get a masters degree; become a master of their craft; or master a skill. It's generally when the word "master" is used along side the word "slave" that it becomes non-inclusive.

Some teams choose to use the word main for the default branch of a repo as opposed to the more commonly used master branch. While it's not required or recommended, your team is empowered to do what works for them. If you do rename the master branch consider using main so that we have consistency among the repos within our organization.

Preferred Phrasing

Non-Inclusive		Inclusive
Whitelist	=>	Allowlist
Blacklist	=>	Denylist
Master / Slave	=>	Leader / Follower; Primary / Standby; etc
Grandfathered	=>	Legacy status
Sanity check	=>	Quick check; Confidence check; etc
Dummy value	=>	Placeholder value; Sample value; etc

Pro Tip 🤓

This list is not comprehensive. If you're aware of other outdated nomenclature please create an issue (PR preferred) with your suggestion.

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means it's critical that we work to make our content as discoverable as possible. Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

That's it, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip 🤓

• If your org is not in the list below, or the table contains errors, please create an issue here.

• While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.

• Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.

• If your application is live, add the production URL.

Ministry Short Codes

Short Code	Organization Name
AEST	Advanced Education, Skills & Training
AGRI	Agriculture
ALC	Agriculture Land Commission
AG	Attorney General
MCF	Children & Family Development
CITZ	Citizens' Services
DBC	Destination BC
EMBC	Emergency Management BC
EAO	Environmental Assessment Office
EDUC	Education
EMPR	Energy, Mines & Petroleum Resources
ENV	Environment & Climate Change Strategy
FIN	Finance
FLNR	Forests, Lands, Natural Resource Operations & Rural Development
HLTH	Health
IRR	Indigenous Relations & Reconciliation
JEDC	Jobs, Economic Development & Competitiveness
LBR	Labour Policy & Legislation
LDB	BC Liquor Distribution Branch
MMHA	Mental Health & Addictions
MAH	Municipal Affairs & Housing
BCPC	Pension Corporation
PSA	Public Service Agency
PSSG	Public Safety and Solicitor General
SDPR	Social Development & Poverty Reduction
TCA	Tourism, Arts & Culture
TRAN	Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 181 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

• If this product is being actively maintained, please close this issue.
• If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

Transfer basic shiny app creation to bcgovr?

👋 @stephanieyurchak

Cool idea! What would you think about extracting the "create a basic shiny app" into the bcgovr package? I think that could fit into that package well and could leverage the code you've written for others.