Increment DESCRIPTION and update README

CDU-data-science-team · Mar 25, 2021 · e5e1be4 · e5e1be4
1 parent 4678b31
commit e5e1be4
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 31 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -6,3 +6,4 @@ dev_history.R
 $run_dev.*
 ^app\.R$
 ^rsconnect$
+^LICENSE\.md$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,13 +1,13 @@
 Package: phaRmacyForecasting
-Title: An Amazing Shiny App
-Version: 0.0.0.9000
-Authors@R: 
-    person(given = "firstname",
-           family = "lastname",
-           role = c("aut", "cre"),
-           email = "your@email.com")
-Description: What the package does (one paragraph).
-License: What license is it under?
+Title: Putting the R in pharmacy- a Shiny application to make forecasts 
+  of medication use in pharmacies in Nottinghamshire Healthcare NHS Trust
+Version: 0.1.0
+Authors@R: person('Chris', 'Beeley', email = 'chris.beeley@gmail.com', role = c('cre', 'aut'))
+Description: This is a Shiny application which allows users to make predictions 
+  on the volumes of drugs issued from Nottinghamshire Healthcare pharmacies. A variety 
+  of forecasting models are used, and options are provided to tweak the forecast to 
+  improve model fit
+License: MIT + file LICENSE
 Imports: 
     config (>= 0.3.1),
     golem (>= 0.3.0),
@@ -38,3 +38,5 @@ Depends:
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+URL: https://github.com/CDU-data-science-team/phaRmacyForecasting
+BugReports: https://github.com/CDU-data-science-team/phaRmacyForecasting/issues
diff --git a/LICENSE b/LICENSE
@@ -1,21 +1,2 @@
-MIT License
-
-Copyright (c) 2020 Clinical Development Unit Data Science Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+YEAR: 2021
+COPYRIGHT HOLDER: Nottinghamshire Healthcare
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2021 Nottinghamshire Healthcare
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 Inventory management of medicines within hospital pharmacies could be improved by harnessing advanced analytics to inform stock ordering requirements. This should release valuable resources which could be used for higher value clinical work. This project aims to develop, test and implement an open source analytical tool in R that will support and improve existing inventory management practices within our Trust pharmacy.
 
+[Link to a very early version of the application](https://involve.nottshc.nhs.uk:8443/pharmacy_forecasting/).
+
 <!-- This repository contains early work forecasting issues of drugs within the Trust (as well as an open dataset). As the project progresses there will be material relating to stock control as well as a Shiny interface to the forecasting and stock control methods.
 
 You can see the output files at the following links:

diff --git a/dev/01_start.R b/dev/01_start.R
@@ -37,7 +37,7 @@ golem::set_golem_options()
 
 ## Create Common Files ----
 ## See ?usethis for more information
-usethis::use_mit_license( name = "Golem User" )  # You can set another license here
+usethis::use_mit_license( copyright_holder = "Nottinghamshire Healthcare" )  # You can set another license here
 usethis::use_readme_rmd( open = FALSE )
 usethis::use_code_of_conduct()
 usethis::use_lifecycle_badge( "Experimental" )