nhs-r-community / isr-iterative-sequential-regression

Updating summary.of.output, plot.fit, master.isr

Source code for NHS-R Community website

Following the values and commitment of the NHS-R Community to open source this website has been built in Quarto to be open in its code and further contribution.

Many of the blogs, which go back to the start of NHS-R Community in 2018, were first posted through a WordPress site and so we don't have a record in GitHub for their contributions, however, the author and the date they wrote the blog are in the source code.

New contributions and corrections can be made directly to this repository through a pull request. Details on how to contribute to an NHS-R Community GitHub repository can be found in the Statement on Tools technical appendix.

This website is not yet live!

Whilst this site is being built the current url www.nhsrcommunity.com is directed to the WordPress site. All the blog posts are being saved under the original titles so that when this site is redirected to the www.nhsrcommunity.com url they will be same as the WordPress.

isr-iterative-sequential-regression's Issues

Use lintr to rename the functions to R friendly names

The functions are in the format with a . to separate words and the package {lintr} will pick these all up so they can be changed line by line. Do this with caution in the first instance as changing too many things with no tests could break something without being obvious.

Move dependency libraries to DESCRIPTION

Lines like this for library(MASS) should be removed. Adding dependency libraries like this can be done using the {usethis} package with code:

usethis::use_package("MASS")

which will update the DESCRIPTION with all the necessary words. It will also put the packages in alphabetical order automatically.

Move file journal.pmed.1001279.s002.DOC

In packages a DOC file will cause issues and either should be linked to or could be incorporated still within the package but copying it into a vignette RMarkdown. An easy way to set up the folders for vignettes and start a file is to use usethis::use_vignette(). The equation might need particular formatting in RMarkdown .

Add documentation to functions

Using the {Roxygen} package when the cursor is in the function name and use the keyboard shortcut Ctrl+Shift+alt+R the skeleton is automatically added.

Preserve original licence text

The MIT licence stipulates that we preserve the original licence text from the package in any derivatvive works. Add this in to the package https://github.com/ischlackow/ISR-iterative-sequential-regression-/blob/main/LICENSE

Repository needs a new package name

Package names are usually short had in the NHSR repository we have an style that's emerged with NHSR at the start with things after in smaller letters. The repository should match the name of the package and this is currently {isr} but the repository is ISR-iterative-sequential-regression- (and has a stray - at the end!).

The name of the package can be changed in the DESCRIPTION file.

Other details can be updated too for the Description and Authors. To copy the format look at the {NHSRplotthedots} as the package has main authors and contributors.

Group functions into separate R scripts

It is possibly better to split these functions out into separate R script according to what they do. For example all the transform/untransform together.