From 2de9db2ceed32006de1befba1b46bc6e95251664 Mon Sep 17 00:00:00 2001 From: StatnMap Date: Mon, 13 May 2024 14:20:08 +0200 Subject: [PATCH] doc: update draw tree doc --- README.Rmd | 6 ++++-- README.md | 7 +++++-- dev/dev_history_cran.R | 2 +- inst/the-dev-history.Rmd | 2 ++ 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.Rmd b/README.Rmd index 05619f59..20a83f30 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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? diff --git a/README.md b/README.md index 7ce41566..a604cdd1 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/dev/dev_history_cran.R b/dev/dev_history_cran.R index d24eebac..89c9efbf 100644 --- a/dev/dev_history_cran.R +++ b/dev/dev_history_cran.R @@ -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", diff --git a/inst/the-dev-history.Rmd b/inst/the-dev-history.Rmd index 628b333c..869193d7 100644 --- a/inst/the-dev-history.Rmd +++ b/inst/the-dev-history.Rmd @@ -59,6 +59,8 @@ usethis::use_readme_rmd() usethis::use_code_of_conduct("contact@fake.com") # 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.**