Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cjrace committed Feb 10, 2024
1 parent 70a0cf9 commit f0b8e76
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,19 @@

`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**
### Scope

`dfeR` is open to all of DfE and anything we think could be useful to other programmers and analysts can be contributed.
This package is open to all of DfE and anything we think could be useful to other programmers and analysts can be contributed, with the exception of R Shiny specific functions. We are also developing the [dfeshiny](https://github.com/dfe-analytical-services/dfeshiny) package, and expect any functions specific to public facing R Shiny dashboards will live there.

Functionality is expected to focus around the following:

1. Templates for analytical projects
2. Publication R Markdown Templates
3. Working with Microsoft SQL Databases
4. DfE specific formatting
1. DfE specific formatting
2. Working with Microsoft SQL Databases
3. Templates for analytical projects
4. Publication R Markdown Templates
5. API wrappers for use internally

Documentation for what has been included in the package so far is available at http://dfe-analytical-services.github.io/dfeR/
Documentation for what has been included in the package so far is available at http://dfe-analytical-services.github.io/dfeR/.

---

Expand All @@ -46,7 +47,7 @@ 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 `dfeR` 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.

---

Expand Down

0 comments on commit f0b8e76

Please sign in to comment.