refactor: change use_reports to create_reports

Refs #3

NAMESPACE

@@ -3,6 +3,7 @@
 export("%>%")
 export(add_gitignore)
 export(create_fairify)
+export(create_reports)
 export(getDataPath)
 export(iconv_filename)
 export(loadConfig)
@@ -10,5 +11,4 @@ export(pkg_sys)
 export(render_report)
 export(render_reports)
 export(updateMermaid)
-export(use_reports)
 importFrom(magrittr,"%>%")

R/use_reports.R → R/create_reports.R

@@ -7,7 +7,7 @@
 #' @export
 #'
 #' @examples
-use_reports <- function(path = ".", overwrite = FALSE) {
+create_reports <- function(path = ".", overwrite = FALSE) {
   # Copy templates
   if (dir.exists(file.path(path, "templates"))) {
     if (overwrite) {

man/use_reports.Rd → man/create_reports.Rd

 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/use_reports.R
-\name{use_reports}
-\alias{use_reports}
+% Please edit documentation in R/create_reports.R
+\name{create_reports}
+\alias{create_reports}
 \title{Set reports folder structure}
 \usage{
-use_reports(path = ".", overwrite = FALSE)
+create_reports(path = ".", overwrite = FALSE)
 }
 \arguments{
 \item{path}{Destination folder for reports and templates}

tests/testthat/test-create_reports.R

+test_that("create_reports works", {
+  path <- tempdir()
+  create_reports(path)
+  expect_error(create_reports(path))
+  expect_warning(create_reports(path,  overwrite = TRUE))
+})