Merge pull request #90 from ImperialCollegeLondon/87_fusen

[Blog fusen] Add suggestions from code review

Author: SaranjeetKaur

docs/posts/20250210_fusen.md

@@ -14,7 +14,7 @@ tags:
 
 !["Origami" by Andy Atzert is licensed under CC BY 2.0. To view a copy of this license, visit https://creativecommons.org/licenses/by/2.0/?ref=openverse.](images/fusen/origami.jpg){: style="display:block;margin:auto;width:69%" }
 
-Writing your first full R package can feel overwhelming and {fusen}
+Writing your first full R package can feel overwhelming, but {fusen}
 can help support at this stage (Even if you are an experienced developer, there is something for you too in this blog. Please read on!). "Fusen" is a type of
 [Japanese origami](https://en.wikipedia.org/wiki/Kamif%C5%ABsen) in which
 a flat piece of paper, when folded in a specific way and inflated, turns
@@ -37,12 +37,12 @@ The CRAN released version of {fusen} can be installed using:
 install.packages("fusen")
 ```
 
-Then we will have to create a new new project in RStudio by following:
+Then we will have to create a new project in RStudio by following:
 `File > New Project > New directory > Package using {fusen}`.
 This will open a `Create Package using {fusen}` wizard.
 Specify the directory name and choose a {fusen} template to work with.
 If you want to see how {fusen} works then select the `teaching` template
-(recommended when using for the first time), else select the `full` template.
+(recommended when using for the first time), otherwise select the `full` template.
 You can also provide a name for the flat file that is to be generated.
 Check `Create a git repository`, `Open in new session` and
 finally click on `Create Project` to create the initial structure.
@@ -105,96 +105,86 @@ fusen::add_flat_template(
 
 This will create a new flat file template named `dev/flat_squared.Rmd` (and `dev/flat_is_even.Rmd` when the corresponding `flat_name` is used) with the various (empty) chunks that can be populated. The chunks that I used for the respective flat files are given below:
 
-<!-- markdownlint-disable-next-line MD033 -->
-<details>
-<!-- markdownlint-disable-next-line MD033 -->
-<summary>Square of a number</summary>
-
-- `function` chunk to square a number:
-
-```` markdown
-```{r function-squared}
-#' Compute squared value
-#'
-#' @param value A numeric value
-#'
-#' @return Numeric.
-#' @export
-
-squared <- function(value) {
-  result <- value^2
-  return(result)
-}
-```
-````
-
-- `examples` chunk to square a number:
-
-```` markdown
-```{r examples-squared}
-squared(10)
-squared(73)
-```
-````
-
-- `tests` chunk to test the function:
-
-```` markdown
-```{r tests-squared}
-test_that("squared works", {
-  expect_equal(squared(10), 100)
-  expect_equal(squared(73), 5329)
-})
-```
-````
-
-</details>
-
-<!-- markdownlint-disable-next-line MD033 -->
-<details>
-<!-- markdownlint-disable-next-line MD033 -->
-<summary>Is a number even?</summary>
-
-- `function` chunk to check if a number is even:
-
-```` markdown
-```{r function-is_even}
-#' Check if a value is even
-#'
-#' @param value A numeric value
-#'
-#' @return Logical. TRUE if value is even, FALSE otherwise
-#' @export
-#'
-
-is_even <- function(value) {
-  result <- value %% 2 == 0
-  return(result)
-}
-```
-````
-
-- `examples` chunk to check if a number is even:
-
-```` markdown
-```{r examples-is_even}
-is_even(20)
-is_even(47)
-```
-````
-
-- `tests` chunk to test the function:
-
-```` markdown
-```{r tests-is_even}
-test_that("is_even works", {
-  expect_true(is_even(20))
-  expect_false(is_even(47))
-})
-```
-````
-
-</details>
+??? "Square of a number"
+
+    `function` chunk to square a number:  <!-- markdownlint-disable-line MD046 -->
+
+    ```` markdown
+    ```{r function-squared}
+    #' Compute squared value
+    #'
+    #' @param value A numeric value
+    #'
+    #' @return Numeric.
+    #' @export
+
+    squared <- function(value) {
+      result <- value^2
+      return(result)
+    }
+    ```
+    ````
+
+    `examples` chunk to square a number:
+
+    ```` markdown
+    ```{r examples-squared}
+    squared(10)
+    squared(73)
+    ```
+    ````
+
+    `tests` chunk to test the function:
+
+    ```` markdown
+    ```{r tests-squared}
+    test_that("squared works", {
+      expect_equal(squared(10), 100)
+      expect_equal(squared(73), 5329)
+    })
+    ```
+    ````
+
+??? "Is a number even?"
+
+    `function` chunk to check if a number is even: <!-- markdownlint-disable-line MD046 -->
+
+    ```` markdown
+    ```{r function-is_even}
+    #' Check if a value is even
+    #'
+    #' @param value A numeric value
+    #'
+    #' @return Logical. TRUE if value is even, FALSE otherwise
+    #' @export
+    #'
+
+    is_even <- function(value) {
+      result <- value %% 2 == 0
+      return(result)
+    }
+    ```
+    ````
+
+    `examples` chunk to check if a number is even:
+
+    ```` markdown
+    ```{r examples-is_even}
+    is_even(20)
+    is_even(47)
+    ```
+    ````
+
+    `tests` chunk to test the function:
+
+    ```` markdown
+    ```{r tests-is_even}
+    test_that("is_even works", {
+      expect_true(is_even(20))
+      expect_false(is_even(47))
+    })
+    ```
+    ````
 
 Inflate each of the two new flat files individually using:
 
@@ -223,11 +213,15 @@ Finally, I will share the package on GitHub using `fusen::init_share_on_github()
 
 If you want to add more functionality to your package, you can continue working on the it locally, inflate any flat files that you generate, and push to GitHub.
 
-[View my.fusen.teaching.package](https://github.com/SaranjeetKaur/my.teaching.fusen.package) (generated by following the above instructions and hosted on GitHub)
+[View my.teaching.fusen.package](https://github.com/SaranjeetKaur/my.teaching.fusen.package) (generated by following the above instructions and hosted on GitHub)
 
 ## Takeaways
 
-{fusen} ensures that you are writing the documentation as well as any associated tests at the same time as writing your code (the best research software engineering practice to begin with!). It is not only useful for first time R package developers, but also for more experienced developers, in the sense that they don't have to switch between R files, tests files, and vignettes while they are prototyping their functions. Since all the related chunks at located in the same flat file, it avoids the risks of forgetting any crucial step. If you retain the flat file(s), then it is also easier to review the code, because everything related to a particular function is available in the same file.
+- {fusen} ensures that you are writing the documentation as well as any associated tests at the same time as writing your code (the best research software engineering practice to begin with!).
+- It is not only useful for first time R package developers, but also for more experienced developers, in the sense that they don't have to switch between R files, tests files, and vignettes while they are prototyping their functions.
+- Since all the related chunks are located in the same flat file, it avoids the risks of forgetting any crucial step.
+- If you retain the flat file(s), then it is also easier to review the code, because everything related to a particular function is available in the same file.
+- It is possible to [switch from a package developed with {fusen} to a classical package](https://thinkr-open.github.io/fusen/articles/switch-from-a-package-developed-with-fusen-to-a-classical-package.html) and continue building the package using the classical approach.
 
 ## Resources