How to use fusen

library(fusen)

How to use {fusen}

Create multiple "flat_xxx.Rmd" files with fusen::add_flat_template(template = "add") if needed

Limitations

Short names

Use \dontrun{}

You can use \dontrun{} in an example chunk as follows:

#' \dontrun{
an_example <- 1 + 1
an_example
#' }

#' OR

#' \dontrun{
#' an_example <- 1 + 1
#' an_example
#' }

Add a new flat_template.Rmd template in “dev” directory

# Create a new project
dummypackage <- tempfile("dummypackage")
dir.create(dummypackage)

# Add an additional dev template
add_flat_template(template = "add", pkg = dummypackage)
#> Created file .here in /tmp/Rtmpd2mC35/dummypackage12c4052de29bcf . Please start a new R session in the new project directory.
#> [1] "/tmp/Rtmpd2mC35/dummypackage12c4052de29bcf/dev/flat_additional.Rmd"

# Delete dummy package
unlink(dummypackage, recursive = TRUE)

Fill your package Description

# Create a new project
dummypackage <- tempfile("dummypackage")
dir.create(dummypackage)

fill_description(
  pkg = dummypackage,
  fields = list(
    Title = "Build A Package From Rmarkdown file",
    Description = paste("Use Rmarkdown First method to build your package.", 
                        "Start your package with documentation.", 
                        "Everything can be set from a Rmarkdown file in your project."),
    `Authors@R` = c(
      person("Sebastien", "Rochette", email = "sebastien@thinkr.fr", 
             role = c("aut", "cre"), comment = c(ORCID = "0000-0002-1565-9313")),
      person(given = "ThinkR", role = "cph")
    )
  )
)
#> ! Title was modified to 'Title Case'.
#> [1] "/tmp/Rtmpd2mC35/dummypackage12c405124f25fb/DESCRIPTION"

# Delete dummy package
unlink(dummypackage, recursive = TRUE)

There can be development actions

These are only included in the flat template file, their content will not be part of the package anywhere else.

Name the following chunk with {r development-1, eval=FALSE}

# Run but keep eval=FALSE to avoid infinite loop

usethis::use_mit_license("Sébastien Rochette")

# Execute in the console directly

fusen::inflate(flat_file = "dev/dev_history.Rmd")

Inflate your package from dev Rmd template

You’re one inflate from flat paper to box. Build your package from the flat Rmd template using the inflate() command below.

After that, you can:

This code creates a package in a temporary directory. You will most probably be inside your project when ready to inflate, hence there will be no need to specify the directory of the package. This code is here as a reproducible example for you to test.

# Create a new project
dummypackage <- tempfile("dummypackage")
dir.create(dummypackage)

# {fusen} steps
fill_description(pkg = dummypackage, fields = list(Title = "Dummy Package"))
dev_file <- add_flat_template(template = "teaching",
                              pkg = dummypackage, overwrite = TRUE)
inflate(
  pkg = dummypackage, 
  flat_file = dev_file, 
  vignette_name = "Exploration of my Data",
  check = FALSE
)

# Explore directory of the package
browseURL(dummypackage)

# Delete dummy package
unlink(dummypackage, recursive = TRUE)

Create a new package from command line directly, using a pre-defined template

# Create a new project
dummypackage <- tempfile(pattern = "dummy")

# {fusen} steps
dev_file <- create_fusen(dummypackage, template = "teaching", open = FALSE)
# Description
fusen::fill_description(pkg = dummypackage, fields = list(Title = "Dummy Package"))

# From inside the package
usethis::with_project(dummypackage, {
  # Define License with use_*_license()
  usethis::use_mit_license("Sébastien Rochette")
  
  # You may need to execute inflate() in the console directly
  fusen::inflate(pkg = dummypackage, 
                 flat_file = dev_file,
                 vignette_name = "Get started")
})