create_project() (#71)

* Added create_project script that includes function to create a new R project with pre-populated files

* Added .dcf file for building the GUI version to create an R projetc using dfeR

* Included dfeR logo (Frederick) so is available to .dcf file

* Adding @examples line to roxygen

* Editing Imports and suggested in description file

* Commenting out line in load_data.R and setting restart to FALSE in renv init

* tests added - basic functionality and renv option

* Some rewording params and allowing the example to run

* devtools check()

* Update _pkgdown.yml for create_project()

* Changing example so it doesn't run when vignette built

* devtools check()

* Initiated renv

* Change renv import to exclude run to stop conflict with rmarkdown, also changed example lib load

* renv package update

* Word list updated for gitignore, num and sep

* Lintr changes

* create proj test lintr changes

* devtools check() ran

* create proj test lintr identation

* Removed version condition on testthat in DESCRIPTION

* Removed renv as it was causing covr to fail

* Removing renv-related .Rbuildignore params

* Adding in data type to roxygen comments and including default value

* Ammended helpers.R script to be renamed utils.R

* Inclusion of R project outline

* Changing helpers to utils in test

* Suppressing messages from create_project in the test

* Tidied roxygen example and added check for params pre-creating a project

* Added message confirming successful creation of project

* Replacing utils with helper_functions naming

* Removed waldo from suggests

* create_project() vignette updated

* Added emo for emoji

* Added .Rprofile, praise not quite working yet. Also added successful creation message.

* Added a bit more pizazz to successful creation message, issues with praise package

* Using {praise} in .Rprofile, re-written {renv} to deal with missing packages, also included new var to delete project if unsuccessful creation

* praise added to package doc

* Updated init_renv test for new warning message

* Suppressing success message from tests

* Adding run.R and changing some of the file names. Including a .renvignore to ignore tests folder. Improving opening message in .Rprofile.

* Removing uneeded packages

* Changed from emo to emoji as is on CRAN

* Added JT as contributor, emoji pkg and tidied order

* Reordered WORDLIST

* Using styler pkg

* Using lintr

* Usethis document

* Increment version number to 0.4.0

* Updated NEWS for create_project()

DESCRIPTION

@@ -1,12 +1,13 @@
 Type: Package
 Package: dfeR
 Title: Common DfE R tasks
-Version: 0.3.1
+Version: 0.4.0
 Authors@R: c(
     person("Cam", "Race", , "[email protected]", role = c("aut", "cre")),
     person("Laura", "Selby", , "[email protected]", role = "aut"),
     person("Adam", "Robinson", role = "aut"),
     person("Jen", "Machin", , "[email protected]", role = "ctb"),
+    person("Jake", "Tufts", , "[email protected]", role = "ctb"),
     person("Rich", "Bielby", , "[email protected]", role = "ctb",
            comment = c(ORCID = "0000-0001-9070-9969"))
   )
@@ -18,7 +19,12 @@ URL: https://dfe-analytical-services.github.io/dfeR/,
     https://github.com/dfe-analytical-services/dfeR
 BugReports: https://github.com/dfe-analytical-services/dfeR/issues
 Imports: 
-    lifecycle
+    emoji,
+    lifecycle,
+    renv,
+    usethis,
+    utils,
+    withr
 Suggests:
     knitr,
     rmarkdown,

NAMESPACE

@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 export(comma_sep)
+export(create_project)
 export(format_ay)
 export(format_ay_reverse)
 export(format_fy)
@@ -10,4 +11,13 @@ export(pretty_filesize)
 export(pretty_num)
 export(pretty_time_taken)
 export(round_five_up)
+import(renv, except = run)
+importFrom(emoji,emoji)
 importFrom(lifecycle,deprecated)
+importFrom(usethis,create_package)
+importFrom(usethis,create_project)
+importFrom(usethis,proj_set)
+importFrom(usethis,use_test)
+importFrom(usethis,use_testthat)
+importFrom(utils,installed.packages)
+importFrom(withr,with_dir)

NEWS.md

@@ -1,3 +1,9 @@
+# dfeR 0.4.0
+
+Add function which creates a DfE R project:
+
+- create_project() 
+
 # dfeR 0.3.1
 
 Fix bug in get_clean_sql() where using the additional settings would lose the original SQL statement