Skip to content

Commit

Permalink
Automated re-knit of the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Moohan committed Oct 21, 2024
1 parent 0134a42 commit d5e2854
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ Status](https://github.com/Public-Health-Scotland/phsmethods/workflows/R-CMD-che
in [Public Health Scotland
(PHS)](https://www.publichealthscotland.scot/):

- `create_age_groups()` categorises ages into groups.
- `chi_check()` assesses the validity of a CHI number.
- `chi_pad()` adds a leading zero to nine-digit CHI numbers.
- `sex_from_chi()` extracts the sex of a person from a CHI number.
- `extract_fin_year()` assigns a date to a financial year in the
format `YYYY/YY`.
- `match_area()` converts geography codes into area names.
- `format_postcode()` formats improperly recorded postcodes.
- `qtr()`, `qtr_end()`, `qtr_next()` and `qtr_prev()` assign a date to
a quarter.
- `age_calculate()` calculates age between two dates.
- `dob_from_chi()` extracts Date of Birth (DoB) from the CHI number.
- `age_from_chi()` extracts age from the CHI number.
- `create_age_groups()` categorises ages into groups.
- `chi_check()` assesses the validity of a CHI number.
- `chi_pad()` adds a leading zero to nine-digit CHI numbers.
- `sex_from_chi()` extracts the sex of a person from a CHI number.
- `extract_fin_year()` assigns a date to a financial year in the format
`YYYY/YY`.
- `match_area()` converts geography codes into area names.
- `format_postcode()` formats improperly recorded postcodes.
- `qtr()`, `qtr_end()`, `qtr_next()` and `qtr_prev()` assign a date to a
quarter.
- `age_calculate()` calculates age between two dates.
- `dob_from_chi()` extracts Date of Birth (DoB) from the CHI number.
- `age_from_chi()` extracts age from the CHI number.

`phsmethods` can be used on both the PHS server and desktop versions of
RStudio.
Expand Down Expand Up @@ -151,17 +151,17 @@ guide](https://style.tidyverse.org/) and the [rOpenSci package
development guide](https://devguide.ropensci.org/). The most pertinent
points to take from these are:

- All function names should be in lower case, with words separated by
an underscore
- Put a space after a comma, never before
- Put a space before and after infix operators such as `<-`, `==` and
`+`
- Limit code to 80 characters per line
- Function documentation should be generated using
[`roxygen2`](https://github.com/r-lib/roxygen2)
- All functions should be tested using
[`testthat`](https://github.com/r-lib/testthat)
- The package should always pass `devtools::check()`
- All function names should be in lower case, with words separated by an
underscore
- Put a space after a comma, never before
- Put a space before and after infix operators such as `<-`, `==` and
`+`
- Limit code to 80 characters per line
- Function documentation should be generated using
[`roxygen2`](https://github.com/r-lib/roxygen2)
- All functions should be tested using
[`testthat`](https://github.com/r-lib/testthat)
- The package should always pass `devtools::check()`

It’s not necessary to have experience with GitHub or of building an R
package to contribute to `phsmethods`. If you wish to contribute code
Expand Down

0 comments on commit d5e2854

Please sign in to comment.