Skip to content

Commit

Permalink
Update Chappter 11 notes. Add DESCRIPTION example file and fusen_tuto…
Browse files Browse the repository at this point in the history
…rial.R script
  • Loading branch information
rserran committed Apr 3, 2024
1 parent 8c778d0 commit 46b5bd9
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 1 deletion.
18 changes: 18 additions & 0 deletions Reproducible_pipelines_book_club/Meeting_07/DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Package: libminer
Title: Explore Your R Libraries
Version: 0.0.0.9000
Authors@R:
person("Ricardo", "Serrano", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = ""))
Description: Provides functions for learning about your R libraries, and the packages you have installed.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
URL: https://github.com/rserran/libminer, https://rserran.github.io/libminer/
BugReports: https://github.com/rserran/libminer/issues
Suggests:
testthat (>= 3.0.0)
Config/testthat/edition: 3
Imports:
fs (>= 1.5)
6 changes: 5 additions & 1 deletion Reproducible_pipelines_book_club/Meeting_07/chapter_11.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

<meta name="author" content="B. Rodrigues/Ricardo J. Serrano">
<meta name="dcterms.date" content="2024-03-21">
<title>quarto-input20a7e03d</title>
<title>quarto-input66bdf568</title>
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
Expand Down Expand Up @@ -425,6 +425,7 @@ <h2><strong>Learning objectives:</strong></h2>
<li>How to turn .Rmd files, including datasets, into a package.</li>
<li>Installing and sharing the package.</li>
<li>Conclusions</li>
<li>Q &amp; A</li>
</ul>
</section>
<section id="section" class="title-slide slide level1 center">
Expand Down Expand Up @@ -582,6 +583,9 @@ <h2>Conclusions</h2>
<li>For beginners, I would recommend to learn the traditional process (step-by-step) of developing R packages (usethis, devtools, roxygen2, etc.).</li>
<li>When you feel more comfortable, then I would recommend to use <code>{fusen}</code>.</li>
</ul>
</section>
<section id="q-a" class="slide level2">
<h2>Q &amp; A</h2>
<div class="footer footer-default">

</div>
Expand Down
3 changes: 3 additions & 0 deletions Reproducible_pipelines_book_club/Meeting_07/chapter_11.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ knitr::opts_chunk$set(echo = TRUE, warning = FALSE, message = FALSE, eval = FALS
- How to turn .Rmd files, including datasets, into a package.
- Installing and sharing the package.
- Conclusions
- Q & A

#

Expand Down Expand Up @@ -185,3 +186,5 @@ fusen::inflate(flat_file = "dev/save_data.Rmd", vignette_name = "Nominal house p
- Developing an R package is a rite passage for any user to learn good coding and documentation practices.
- For beginners, I would recommend to learn the traditional process (step-by-step) of developing R packages (usethis, devtools, roxygen2, etc.).
- When you feel more comfortable, then I would recommend to use `{fusen}`.

## Q & A
17 changes: 17 additions & 0 deletions Reproducible_pipelines_book_club/Meeting_07/fusen_tutorial.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Building reproducible analytical pipelines with R
# Chapter 11 - Packaging your code

# load packages
if (!require("fusen")){
install.packages("fusen")
library(fusen)
}

# quickstart
fusen::create_fusen(path = "fusen.quickstart",
template = "minimal")

# set and try pkgdown documentation website
usethis::use_pkgdown()
pkgdown::build_site()

0 comments on commit 46b5bd9

Please sign in to comment.