Merge pull request #267 from ThinkR-open/adding_dev_chunk_in_templates

feat: Add development chunk in fusen templates

dev/flat_create_flat.Rmd

@@ -665,9 +665,9 @@ test_that("Other flat_name works", {
   )
   expect_true(file.exists(file.path(dummypackage, "dev/flat_hello.Rmd")))
   hello_flat <- readLines(dev_file_path)
-  # 9 times hello for function name
+  # 10 times hello for function name
   # 2 times hello in flat_hello.Rmd
-  expect_equal(length(grep("hello", hello_flat)), 9 + 2)
+  expect_equal(length(grep("hello", hello_flat)), 10 + 2)
   expect_equal(length(grep("flat_hello[.]Rmd", hello_flat)), 2)
 
   # Template minimal used with "minpkg", same name, flat changes name
@@ -683,9 +683,9 @@ test_that("Other flat_name works", {
   flat_file <- file.path(dummypackage, "dev/flat_hello_2.Rmd")
   expect_true(file.exists(flat_file))
   hello_flat <- readLines(flat_file)
-  # 9 times hello for function name
+  # 10 times hello for function name
   # 2 times hello in flat_hello_2.Rmd
-  expect_equal(length(grep("hello", hello_flat)), 9 + 2)
+  expect_equal(length(grep("hello", hello_flat)), 10 + 2)
   expect_equal(length(grep("flat_hello_2[.]Rmd", hello_flat)), 2)
 
   # Try inflate to see if files get hello name
@@ -735,11 +735,11 @@ test_that("Other dev_dir works", {
   expect_true(file.exists(file.path(dummypackage, "devdir/flat_hello.Rmd")))
   hello_flat <- readLines(dev_file_path)
 
-  # 9 times hello for function name
+  # 10 times hello for function name
   # 2 times hello in flat_hello.Rmd
   # 1 time devdir/flat_hello.Rmd
   # O time dev/flat_hello.Rmd
-  expect_equal(length(grep("hello", hello_flat)), 9 + 2)
+  expect_equal(length(grep("hello", hello_flat)), 10 + 2)
   expect_equal(length(grep("flat_hello[.]Rmd", hello_flat)), 2)
   expect_equal(length(grep("devdir/flat_hello[.]Rmd", hello_flat)), 1)
   expect_equal(length(grep("dev/flat_hello[.]Rmd", hello_flat)), 0)
@@ -833,8 +833,8 @@ test_that("add_flat_template allows bad flat_name for function name with add", {
   )))
 
   dev_lines <- readLines(flat_file)
-  # title x 1, function x 3, example x 2, tests x 3
-  expect_equal(length(grep("bad_for_function_but_ok2", dev_lines)), 9)
+  # title x 1, development x 1, function x 3, example x 2, tests x 3
+  expect_equal(length(grep("bad_for_function_but_ok2", dev_lines)), 10)
 })
 unlink(dummypackage, recursive = TRUE)
 ```

inst/flat-template-additional.Rmd

@@ -16,6 +16,10 @@ pkgload::load_all(export_all = FALSE)
 
 # my_fun
 
+```{r development-my_fun}
+# Prepare the code of your function here
+```
+
 ```{r function-my_fun}
 #' my_fun Title
 #'

inst/flat-template-full.Rmd

@@ -63,6 +63,10 @@ After inflating the template
 -  This function code will automatically be added in a new file in the "R/" directory
 -->
 
+```{r development-function}
+# Prepare the code of your function here
+```
+
 ```{r function}
 #' My median
 #'
@@ -75,7 +79,9 @@ After inflating the template
 #'
 #' @examples
 my_median <- function(x, na.rm = TRUE) {
-  if (!is.numeric(x)) {stop("x should be numeric")}
+  if (!is.numeric(x)) {
+    stop("x should be numeric")
+  }
   stats::median(x, na.rm = na.rm)
 }
 ```
@@ -101,7 +107,7 @@ my_median(1:12)
 datafile <- system.file("nyc_squirrels_sample.csv", package = "<my_package_name>")
 nyc_squirrels <- read.csv(datafile, encoding = "UTF-8")
 # Apply my function
-my_median(nyc_squirrels[,"hectare_squirrel_number"])
+my_median(nyc_squirrels[, "hectare_squirrel_number"])
 ```
 
 <!--
@@ -128,7 +134,7 @@ datafile <- system.file("nyc_squirrels_sample.csv", package = "<my_package_name>
 nyc_squirrels <- read.csv(datafile, encoding = "UTF-8")
 # Apply test on my function
 test_that("my_median works properly with internal dataset", {
-  expect_equal(my_median(nyc_squirrels[,"hectare_squirrel_number"]), 3)
+  expect_equal(my_median(nyc_squirrels[, "hectare_squirrel_number"]), 3)
 })
 ```
 
@@ -153,8 +159,10 @@ Each of them will be inflated in a different file, provided that there is a leve
 #'
 #' @examples
 my_other_median <- function(x, na.rm = TRUE) {
-  if (!is.numeric(x)) {stop("x should be numeric")}
-  sub_median(x, na.rm =na.rm)
+  if (!is.numeric(x)) {
+    stop("x should be numeric")
+  }
+  sub_median(x, na.rm = na.rm)
 }
 
 #' Core of the median not exported

inst/flat-template-minimal_package.Rmd

@@ -20,6 +20,10 @@ pkgload::load_all(export_all = FALSE)
 
 # my_fun
 
+```{r development-my_fun}
+# Prepare the code of your function here
+```
+
 ```{r function-my_fun}
 #' my_fun Title
 #'

inst/flat-template-teaching.Rmd

@@ -48,11 +48,16 @@ You can add `1` to any `value` using function `add_one()`.
 <!-- 
 This first section shows:
 
+- a development part to prepare the code of the function
 - the three parts necessary for a package: 'function', 'examples' and 'tests'.  
-  + Note that the three following chunks have names accordingly.
+  + Note that the four following chunks have names accordingly.
 
 -->
 
+```{r development-add_one}
+# Prepare the code of your function here
+```
+
 ```{r function-add_one}
 #' Add one to any value
 #'

tests/testthat/test-add_flat_template.R

@@ -370,9 +370,9 @@ test_that("Other flat_name works", {
   )
   expect_true(file.exists(file.path(dummypackage, "dev/flat_hello.Rmd")))
   hello_flat <- readLines(dev_file_path)
-  # 9 times hello for function name
+  # 10 times hello for function name
   # 2 times hello in flat_hello.Rmd
-  expect_equal(length(grep("hello", hello_flat)), 9 + 2)
+  expect_equal(length(grep("hello", hello_flat)), 10 + 2)
   expect_equal(length(grep("flat_hello[.]Rmd", hello_flat)), 2)
 
   # Template minimal used with "minpkg", same name, flat changes name
@@ -388,9 +388,9 @@ test_that("Other flat_name works", {
   flat_file <- file.path(dummypackage, "dev/flat_hello_2.Rmd")
   expect_true(file.exists(flat_file))
   hello_flat <- readLines(flat_file)
-  # 9 times hello for function name
+  # 10 times hello for function name
   # 2 times hello in flat_hello_2.Rmd
-  expect_equal(length(grep("hello", hello_flat)), 9 + 2)
+  expect_equal(length(grep("hello", hello_flat)), 10 + 2)
   expect_equal(length(grep("flat_hello_2[.]Rmd", hello_flat)), 2)
 
   # Try inflate to see if files get hello name
@@ -440,11 +440,11 @@ test_that("Other dev_dir works", {
   expect_true(file.exists(file.path(dummypackage, "devdir/flat_hello.Rmd")))
   hello_flat <- readLines(dev_file_path)
 
-  # 9 times hello for function name
+  # 10 times hello for function name
   # 2 times hello in flat_hello.Rmd
   # 1 time devdir/flat_hello.Rmd
   # O time dev/flat_hello.Rmd
-  expect_equal(length(grep("hello", hello_flat)), 9 + 2)
+  expect_equal(length(grep("hello", hello_flat)), 10 + 2)
   expect_equal(length(grep("flat_hello[.]Rmd", hello_flat)), 2)
   expect_equal(length(grep("devdir/flat_hello[.]Rmd", hello_flat)), 1)
   expect_equal(length(grep("dev/flat_hello[.]Rmd", hello_flat)), 0)
@@ -538,8 +538,8 @@ test_that("add_flat_template allows bad flat_name for function name with add", {
   )))
 
   dev_lines <- readLines(flat_file)
-  # title x 1, function x 3, example x 2, tests x 3
-  expect_equal(length(grep("bad_for_function_but_ok2", dev_lines)), 9)
+  # title x 1, development x 1, function x 3, example x 2, tests x 3
+  expect_equal(length(grep("bad_for_function_but_ok2", dev_lines)), 10)
 })
 unlink(dummypackage, recursive = TRUE)