-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
24 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,3 +6,4 @@ | |
^pkgdown$ | ||
^\.github$ | ||
^CODE_OF_CONDUCT\.md$ | ||
^codecov\.yml$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,9 +2,9 @@ | |
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help | ||
on: | ||
push: | ||
branches: [main] | ||
branches: [main, master] | ||
pull_request: | ||
branches: [main] | ||
branches: [main, master] | ||
|
||
name: test-coverage | ||
|
||
|
@@ -48,9 +48,3 @@ jobs: | |
with: | ||
name: coverage-test-failures | ||
path: ${{ runner.temp }}/package | ||
|
||
- name: Upload coverage reports to Codecov | ||
uses: codecov/[email protected] | ||
env: | ||
token: ${{ secrets.CODECOV_TOKEN }} | ||
slug: dfe-analytical-services/dfeR |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,19 @@ | ||
# dfeR | ||
|
||
--- | ||
|
||
<!-- badges: start --> | ||
[](https://github.com/dfe-analytical-services/dfeR/actions/workflows/R-CMD-check.yaml) | ||
[](https://github.com/dfe-analytical-services/dfeR/actions/workflows/pkgdown.yaml) | ||
[](https://github.com/dfe-analytical-services/dfeR/actions/workflows/test-coverage.yaml) | ||
[](https://lifecycle.r-lib.org/articles/stages.html#experimental) | ||
[](https://app.codecov.io/gh/dfe-analytical-services/dfeR?branch=main) | ||
<!-- badges: end --> | ||
|
||
--- | ||
# dfeR | ||
|
||
## Introduction | ||
|
||
dfeR is an R package designed to help standardise R programming across the Department for Education (DfE) and facilitate sharing of business specific functions. | ||
`dfeR` is an R package designed to help standardise R programming across the Department for Education (DfE) and facilitate sharing of business specific functions. | ||
|
||
**Scope** | ||
|
||
dfeR is open to all of DfE and anything we think could be useful to other programmers and analysts can be contributed. | ||
`dfeR` is open to all of DfE and anything we think could be useful to other programmers and analysts can be contributed. | ||
|
||
Functionality is expected to focus around the following: | ||
|
||
|
@@ -32,7 +28,7 @@ Documentation for what has been included in the package so far is available at h | |
|
||
## Installation | ||
|
||
dfeR is not currently available on CRAN. For the time being you can install the development version from GitHub. | ||
`dfeR` is not currently available on CRAN. For the time being you can install the development version from GitHub. | ||
|
||
If you are using `renv` in your project (recommended): | ||
|
||
|
@@ -50,13 +46,13 @@ devtools::install_github("dfe-analytical-services/dfeR") | |
|
||
## Proxy | ||
|
||
The need for setting proxy settings in order to be able to work with R and git within the DfE estate has now ended. If you previously run the proxy script in previous versions of the DfE R package, then contact the [Statistics Development team]([email protected]) to assist in cleaning out your system settings. | ||
The need for setting proxy settings in order to be able to work with R and Git within the DfE estate has now ended. If you previously run the proxy script in previous versions of the `dfeR` package, then contact the [Statistics Development team]([email protected]) to assist in cleaning out your system settings. | ||
|
||
--- | ||
|
||
## Contributing | ||
|
||
Ideas for dfeR should first be raised as a [GitHub issue](https://github.com/dfe-analytical-services/dfeR) after which anyone is free to write the code and create a pull request for review. | ||
Ideas for `dfeR` should first be raised as a [GitHub issue](https://github.com/dfe-analytical-services/dfeR) after which anyone is free to write the code and create a pull request for review. | ||
|
||
When contributing to dfeR you should work on a new branch and, where applicable, you will be asked to: | ||
|
||
|
@@ -73,4 +69,3 @@ Once your changes have been merged they should appear almost immediately, though | |
## Code of Conduct | ||
|
||
Please note that the dfeR project is released with a [Contributor Code of Conduct](https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
comment: false | ||
|
||
coverage: | ||
status: | ||
project: | ||
default: | ||
target: auto | ||
threshold: 1% | ||
informational: true | ||
patch: | ||
default: | ||
target: auto | ||
threshold: 1% | ||
informational: true |