New 'setup' section (#5)

* New 'setup' section

* Remove load_all() since it's interactive

* Start from a blank slate

* Update README

* Use rlang's %||% so it works with older R

* Document

.Rbuildignore

@@ -6,3 +6,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^Taskfile\.yml$

DESCRIPTION

@@ -13,3 +13,5 @@ URL: https://ixpantia.github.io/inc.rtests/
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+Imports: 
+    rlang

NAMESPACE

@@ -1,3 +1,4 @@
 # Generated by roxygen2: do not edit by hand
 
 export(greet)
+importFrom(rlang,"%||%")

R/inc.rtests-package.R

@@ -0,0 +1,7 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+#' @importFrom rlang %||%
+## usethis namespace: end
+NULL

README.md

@@ -117,4 +117,67 @@ Live.
 [example](https://github.com/ixpantia/tower/pull/14/files#diff-8fe6f19b5ce17649a885f3ad91e83f63c1ca2dc91dbcd00fa3bd7e242f80dda7).
 * The "incubator" format ([template](https://github.com/dsincubator/template)).
 
+## Setup
+
+> As a developer I want to setup a fresh system so that I can use the devtools workflow to develop an R package.
+
+From an R package in a fresh environment (e.g. on GitHub Codespaces):
+
+* Install R: https://github.com/r-lib/rig
+
+* Ensure to start R from a blank slate:
+
+```bash
+# ~/.bash_aliases
+alias R="R --no-save --no-restore-data"
+```
+
+* Install R-package dependencies: `pak::pak()`
+
+* Install devtools: `pak::pak("devtools")`
+
+* Setup devtools: `usethis::use_devtools()` 
+
+```r
+# .Rprofile
+if (interactive()) {
+  suppressMessages(require(devtools))
+}
+```
+
+* Restart R:
+  * Quit R from the R console: `q()`
+  * Start R from the terminal: `R`
+
+* Setup the devtools workflow as aliases, then run each `alias` from ther terminal, e.g. `rtest`
+
+```bash
+# ~/.bash_aliases 
+alias rtest="Rscript -e 'devtools::test()'"
+alias rdocument="Rscript -e 'devtools::document()'"
+alias rcheck="Rscript -e 'devtools::check()'"
+```
+
+* Setup the devtools workflow in a [Taskfile.yml](https://taskfile.dev/installation/) then:
+  * run each `task` from the [extension](https://marketplace.visualstudio.com/items?itemName=task.vscode-task), or
+  * run each `task` from the terminal, e.g. `task test`.
+
+```yaml
+# Taskfile.yml
+version: '3'
+
+tasks:
+  test:
+    cmds:
+      - Rscript -e "devtools::test()"
+  document:
+    cmds:
+      - Rscript -e "devtools::document()"
+  check:
+    cmds:
+      - Rscript -e "devtools::check()"
+```
+
+For more tasks see Taskfile.yml
+
 </details>

Taskfile.yml

@@ -0,0 +1,43 @@
+version: '3'
+
+tasks:
+  load_all:
+    cmds:
+      - Rscript -e "devtools::load_all()"
+  test:
+    cmds:
+      - Rscript -e "devtools::test()"
+  document:
+    cmds:
+      - Rscript -e "devtools::document()"
+  check:
+    cmds:
+      - Rscript -e "devtools::check()"
+  build_site:
+    cmds:
+      - Rscript -e "pkgdown::build_site()"
+  preview_site:
+    cmds:
+      - Rscript -e "pkgdown::preview_site()"
+  tidy_descrition:
+    cmds:
+      - Rscript -e "usethis::use_tidy_description()"
+  style:
+    cmds:
+      - Rscript -e "usethis::use_tidy_style()"
+  spell_check:
+    cmds:
+      - Rscript -e "spelling::spell_check_package()"
+  test_integration:
+    cmds:
+      - Rscript -e "devtools::load_all(); testthat::test_dir('tests/integration')"
+  package_coverage:
+    cmds:
+      - Rscript -e "covr::package_coverage()"
+  build_readme:
+    cmds:
+      - Rscript -e "devtools::build_readme()"
+  run_examples:
+    cmds:
+      - Rscript -e "devtools::run_examples()"
+

tests/integration/test-greet.R

@@ -0,0 +1,7 @@
+test_that("works", {
+  expect_equal(greet(), "hello world")
+})
+
+test_that("con 'Mauro' devuelve hello Mauro", {
+  expect_equal(greet('Mauro'), "hello Mauro")
+})