Skip to content

Commit

Permalink
Bump to v0.4
Browse files Browse the repository at this point in the history
Release !
  • Loading branch information
statnmap committed Apr 29, 2022
1 parent 2cd88b8 commit f249ac3
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 6 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
@@ -1,6 +1,6 @@
Package: fusen
Title: Build a Package from Rmarkdown File
Version: 0.3.0.9000
Version: 0.4.0
Authors@R: c(
person("Sebastien", "Rochette", , "sebastien@thinkr.fr", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-1565-9313")),
Expand Down
8 changes: 4 additions & 4 deletions NEWS.md
@@ -1,4 +1,4 @@
# fusen 0.3.0.9000
# fusen 0.4.0

## New features

Expand Down Expand Up @@ -37,8 +37,8 @@ ALanguillaume)
* Avoid creating vignette with `inflate(vignette_name = NA)`
* Decide whether or not to open vignette when inflate with `inflate(open_vignette = FALSE)`
* Improve documentation included in flat templates to reflect changes in using dev_history file
* Add Rstudio Addin to insert a new flat template
* Add Rstudio Addin to insert chunks for new function (@ColinFay)
* Add RStudio Addin to insert a new flat template
* Add RStudio Addin to insert chunks for new function (@ColinFay)
* Deal with `\dontrun{}` in example chunks
* Allow short names for chunks: dev, fun, ex, test
* `create_fusen()` to create a {fusen} project from command line or with RStudio new project (@ALanguillaume)
Expand All @@ -61,7 +61,7 @@ ALanguillaume)
* Fix inflate with empty functions chunks
* Fix filename to inflate in templates with new calls of `add_dev_history()` (@Cervangirard)
* Default vignette name is now "Get started" creating "vignettes/get-started.Rmd"
* All open files are saved when using `inflate()` where {rstudioapi} works
* All open files are saved when using `inflate()` where {RStudioapi} works
* Ask to restart RStudio after first inflate

# fusen 0.2.4
Expand Down
16 changes: 16 additions & 0 deletions README.Rmd
Expand Up @@ -152,6 +152,22 @@ After that, you need to move your functions and scripts in the correct place. Le

*{fusen} is also addressed to more advanced developers who are fed up with switching* between R files, tests files, vignettes. In particular, when changing arguments of a function, we need to change examples, unit tests in multiple places. Here, you can do it in one place. No risk to forget one. Think also about code review: everything related to one function is at the same place.

## Q&A : All tips and tricks of a {fusen} template

- Can I be lazy in names used?
- Can I knit the content of the flat template ?
- How to declare packages with library() for the future vignette ?
- How to include examples that cannot be run ?
- Document your internal datasets in a function chunk as usual
- How to ignore some chunks ?
- How to create a vignette with different title and Index Entry?
- How not to create a vignette ?
- How to get a pre-filled template for a specific function name ?
- How to Inflate multiple flat files ?
- How to store multiple functions in a unique R file ?
- How to read dataset that I usually put in “tests/testthat/” for my unit tests?

=> See vignette Tips and Tricks: https://thinkr-open.github.io/fusen/articles/tips-and-tricks.html

## Why is this package named {fusen} ?

Expand Down
19 changes: 19 additions & 0 deletions README.md
Expand Up @@ -193,6 +193,25 @@ tests in multiple places. Here, you can do it in one place. No risk to
forget one. Think also about code review: everything related to one
function is at the same place.

## Q&A : All tips and tricks of a {fusen} template

- Can I be lazy in names used?
- Can I knit the content of the flat template ?
- How to declare packages with library() for the future vignette ?
- How to include examples that cannot be run ?
- Document your internal datasets in a function chunk as usual
- How to ignore some chunks ?
- How to create a vignette with different title and Index Entry?
- How not to create a vignette ?
- How to get a pre-filled template for a specific function name ?
- How to Inflate multiple flat files ?
- How to store multiple functions in a unique R file ?
- How to read dataset that I usually put in “tests/testthat/” for my
unit tests?

=> See vignette Tips and Tricks:
<https://thinkr-open.github.io/fusen/articles/tips-and-tricks.html>

## Why is this package named {fusen} ?

A fusen is an origami. It is a flat piece of paper that you fold in a
Expand Down
5 changes: 4 additions & 1 deletion dev/dev_history.R
Expand Up @@ -220,6 +220,9 @@ spelling::spell_check_package()
urlchecker::url_check()
urlchecker::url_update()

# Upgrade version number
usethis::use_version(which = c("patch", "minor", "major", "dev")[2])

# check on other distributions
# _rhub
devtools::check_rhub()
Expand Down Expand Up @@ -248,7 +251,7 @@ rstudioapi::navigateToFile(system.file(package = "rhub", "bin", "rhub-linux-dock
# /opt/R-devel/bin/R


rhub::check(platform = "windows-x86_64-devel")
rhub::check(platform = "windows-x86_64-devel", show_status = FALSE)

# _win devel
devtools::check_win_devel()
Expand Down

0 comments on commit f249ac3

Please sign in to comment.