Skip to content

Commit

Permalink
doc: update draw tree doc
Browse files Browse the repository at this point in the history
  • Loading branch information
statnmap committed May 13, 2024
1 parent b402a32 commit 2de9db2
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
6 changes: 4 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,12 @@ _Note that the `"flat*.Rmd"` files created with templates `full` and `teaching`

There is a dedicated vignette to answer this: https://thinkr-open.github.io/fusen/articles/Maintain-packages-with-fusen.html

- **Option 1**: After a first inflate of your flat file, you can continue developing in the "flat_template.Rmd" file, and then inflate it using `fusen::inflat_all()`
- **Option 1**: After a first inflate of your flat file, you can continue developing in the "flat_template.Rmd" file, and then inflate it using `fusen::inflate_all()`
- **Option 2**: After you're done with inflating, you can decide to deprecate your flat file with `fusen::deprecate_flat_file()` and develop in the package files directly, as for any other R package. 'fusen' has no impact on the structure of a classical package once inflated.

> Advice : Use git as soon as possible, this will avoid losing your work if you made some modifications in the wrong place
> Advice: Use git as soon as possible, this will avoid losing your work if you made some modifications in the wrong place
> Advice: Show the package structure with `fusen::draw_the_tree()` in a "dev/Readme.md" file to help developers
## Who is {fusen} for?

Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,16 +180,19 @@ There is a dedicated vignette to answer this:

- **Option 1**: After a first inflate of your flat file, you can
continue developing in the “flat\_template.Rmd” file, and then
inflate it using `fusen::inflat_all()`
inflate it using `fusen::inflate_all()`
- **Option 2**: After you’re done with inflating, you can decide to
deprecate your flat file with `fusen::deprecate_flat_file()` and
develop in the package files directly, as for any other R package.
‘fusen’ has no impact on the structure of a classical package once
inflated.

> Advice : Use git as soon as possible, this will avoid losing your work
> Advice: Use git as soon as possible, this will avoid losing your work
> if you made some modifications in the wrong place
> Advice: Show the package structure with `fusen::draw_the_tree()` in a
> “dev/Readme.md” file to help developers
## Who is {fusen} for?

If you mind about documentation for your users and tests for your
Expand Down
2 changes: 1 addition & 1 deletion dev/dev_history_cran.R
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Sys.setenv("FUSEN_TEST_PUBLISH" = "FALSE")
#> rig run
devtools::check()

# Update the map of the package
# Update the tree structure of the package
fusen::draw_the_tree()

rmarkdown::render("dev/README.Rmd",
Expand Down
2 changes: 2 additions & 0 deletions inst/the-dev-history.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ usethis::use_readme_rmd()
usethis::use_code_of_conduct("[email protected]")
# NEWS
usethis::use_news_md()
# Package structure (add this in a dev/Readme.md file)
fusen::draw_the_tree()
```

**From now, you will need to "inflate" your package at least once to be able to use the following commands. Let's go to your flat template, and come back here later if/when needed.**
Expand Down

0 comments on commit 2de9db2

Please sign in to comment.