An R package to automate set up and sharing of R projects in bcgov GitHub following bcgov guidelines.
All B.C. Government employees are responsible for determining whether bcgov R source code can be shared on bcgov GitHub and for following the BC-Policy-Framework-For-GitHub.
You will need to ensure that Git is installed on your computer. To add your project to bcgov GitHub users need to have a GitHub account and be a member of the bcgov GitHub organisation.
create_bcgov_project()
& create_bcgov_package()
Create a new—or
populate an existing—R project or R package with folders & files that
encourage best practice in scientific computing and with files that
ensure the project meets bcgov GitHub
requirements.
use_bcgov_git()
Initialise Git version control
for an R project and add files that ensure the project meets bcgov
GitHub
requirements.
use_bcgov_github()
Open a bcgov GitHub
repository and synchronise with an existing
local R project and add files that ensure the project meets bcgov
GitHub
requirements.
use_bcgov_github()
requires that your project already be a Git
repository. Use use_bcgov_git()
to initialise a Git repository.
create_from_bcgov_github()
Clone a bcgov GitHub
repository and add files that ensure the
project meets bcgov GitHub
requirements.
use_bcgov_req()
Add files to a new or existing R project to meet
bcgov GitHub
requirements.
You can also add the bcgov required
files
individually using use_bcgov_contributing()
, use_bcgov_licence()
,
use_bcgov_readme()
, use_bcgov_readme_rmd()
,
use_bcgov_code_of_conduct()
.
The create_bcgov_project()
or create_bcgov_package()
and
use_bcgov_git
functions can be used simultaneously through the bcgovr
Project & Package templates in the RStudio
New Project dialogue box. The dialogue box allows a user to create a new
R project or package with the option to select and individualise the
required bcgov GitHub files and initialise Git version control.
The bcgovr
package installs a set of RStudio
Addins:
1) Insert the boiler-plate Apache 2.0 license
header
into the comments header of a source file (uses
insert_bcgov_apache_header()
).
2) Insert the boiler-plate Creative Commons Attribution 4.0
International License
header
into the comments header of a source file (uses
insert_bcgov_cc_header()
).
3) Insert a bcgov project lifecycle
badge
into an .Rmd or .md file to indicate the current state of a project
(uses insert_bcgov_lifecycle_badge()
).
You can install bcgovr
directly from this GitHub repository. To do so,
you will need the remotes
package:
install.packages("remotes")
Next, install and load the bcgovr
package using
remotes::install_github()
:
remotes::install_github("bcgov/bcgovr")
library(bcgovr)
🎉 The authors of bcgovr
acknowledge and thank the authors of the
usethis
R
package—bcgovr
uses usethis
a lot. And by a lot, we mean every
bcgovr
function uses usethis
under the hood 🚘.
There are several options you can specify in your .Rprofile
file to
customise the default behaviour when using the create_bcgov_
and
use_bcgov_
functions in bcgovr
.
bcgovr.coc.email
: Code of Conduct contact email address
bcgovr.dir.struct
: Alternative project directory structure for
create_bcgov_project()
. This should be specified as a character
vector of directory (i.e. folders) and file paths, relative to the
root of the project. Directories should be identified by having a
trailing forward-slash (e.g., "dir/"
).
The default is:
c("R/", "data/", "out/", "01_load.R", "02_clean.R", "03_analysis.R", "04_output.R", "internal.R", "run_all.R")
.
To make use of these options, there should be a section in your
.Rprofile
file that looks something like this:
if (interactive()) {
options("bcgovr.coc.email" = "my.email@gov.bc.ca")
options("bcgovr.dir.struct" = c("doc/", "data/", "results/", "src/01_load.R", "src/02_clean.R",
"src/03_analysis.R", "src/04_output.R", "src/run_all.R"))
}
The easiest way to edit your .Rprofile
is to run
usethis::edit_r_profile()
. It will open up the file in RStudio for
editing. Then save the file, restart R, and your settings will be saved.
This package is relatively stable and available for general use.
To report bugs/issues/feature requests, please file an Issue.
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.
Copyright 2017 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 repository is maintained by Environmental Reporting BC. Click here for a complete list of our repositories on GitHub.