Future road map

Here is the list of features and bugs opened that may be treated in the future.
Once the ongoing roadmap is clear, some of these items will be prioritize for the next release.

If these were coming from opened issues, the issue will be "closed as not programmed" with a tag see wiki for planification, with a comment like: "This issue is listed in the future roadmap. It will be re-opened when necessary. See: https://github.com/ThinkR-open/fusen/wiki/Future-road-map"

Emoji Legend

• 🍌 Probably features that will be approved for next road map
• 🆗 The issue has all information needed to be treated
• 🟠 The issue is quite clear and has almost all information
• 🔴 The issue is not clear enough
• ⏸️ We keep it in case we have time or someone wants to help, but we probably won't address it
• ⚠️ We faced a problem to be addressed
• ⏳ Number of days estimated for a section

Bugs / doc

• 🆗 add {fusen} chunk addin doesn't work when Rmd is in "new window" (floating Rstudio windows): https://github.com/ThinkR-open/fusen/issues/168
• 🆗 [fix] : As user, I want to be able to use "{" and "}" in fusen::inflate() vignette_name: https://github.com/ThinkR-open/fusen/issues/200
• [feat] : Add a fusen::use_contributing() function to create a CONTRIBUTING file explaining how to contribute with {fusen} made packages.
  • USe the one of {fusen} as example (to combine to the usethis one I guess): https://github.com/ThinkR-open/fusen/blob/main/CONTRIBUTING.md
  • Issue related: https://github.com/ThinkR-open/fusen/issues/241
• 🆗 inflate_all() may not keep vignette name when different from entry name: https://github.com/ThinkR-open/fusen/issues/231

Clean the project

• Add a tool to detect duplicates functions in "R/" directory.
• Detect duplicate function names in R files however, just in case. detect_duplicated_functions()

Clean package during inflate() function:

As a dev, I would like to run inflate() without parameters in the console

• Store inflate options in the flat file header so that if I run directly fusen::inflate() in the console, it is correctly inflated
• Inflate_all() could also run the complete clean ? Maybe not now. Wait for the functions to be extensively tested

Simplify inflate() calls

• 🆗 As dev, I want that the yaml header of a flat file contains the arguments of the inflate() call: https://github.com/ThinkR-open/fusen/issues/191
• Make fusen::inflate() self-aware: https://github.com/ThinkR-open/fusen/issues/14
• ⏸️ As dev, I get all information of my flat files in a text config file: https://github.com/ThinkR-open/fusen/issues/190

🍌 Clean files produced by {fusen}

See "dev/flat_clean_fusen_files.Rmd"

• Clean comments in the vignette: https://github.com/ThinkR-open/fusen/issues/128
• Tidy Style and Get rid of extra spaces when working with different OS ?: https://github.com/ThinkR-open/fusen/issues/75
• Deal with machine not using UTF8 encoding by default: https://github.com/ThinkR-open/fusen/issues/132
• 🟠 feat: Explain how to use the flat file with internal functions: https://github.com/ThinkR-open/fusen/issues/158

Help build other parts of the package

• Help build the Readme: https://github.com/ThinkR-open/fusen/issues/1
• Help build NEWS: https://github.com/ThinkR-open/fusen/issues/3
• Help deal with dataset: https://github.com/ThinkR-open/fusen/issues/4

Customization

• 🆗 Define a vignette for developers / or a pre-built vignette ?: https://github.com/ThinkR-open/fusen/issues/141
• 🆗 Add a parameter in add_flat_template() to specify the name of the vignette: https://github.com/ThinkR-open/fusen/issues/165
• Extending {fusen} with your own template: https://github.com/ThinkR-open/fusen/issues/61
• Use options("usethis.full_name") for the author field in Rmd: https://github.com/ThinkR-open/fusen/issues/51
• golem hooks & template: https://github.com/ThinkR-open/fusen/issues/85
• Allow combination of flat templates in a unique vignette ?: https://github.com/ThinkR-open/fusen/issues/111
• Simplify the use of fill_description() with field parameter being the option rather than the rule

More info for `fill_description()`:

• Add parameters `title`, `description`, `maintainer`
• Show them by default in the flat template, instead of `fields`
• Keep `fields` and show example o use for multiple users
• Fill `fields` internally to account for `title`, `description`, `maintainer`

Help deal with the differences between a classical Rmd/Qmd and what {fusen} does

• Automatically check if examples are working correctly and independently: https://github.com/ThinkR-open/fusen/issues/9

Reverse process

• deflate() an existing package to update existing functions: https://github.com/ThinkR-open/fusen/issues/16

Other combinations of tools

• 🍌🆗 I'd like some qmd flat files instead of Rmd: https://github.com/ThinkR-open/fusen/issues/175
• 🆗 I'd like functions of {checkhelper} to be listed in the "0-dev_history": https://github.com/ThinkR-open/fusen/issues/185
• 🟠 Show how to combine with {roxytest}: https://github.com/ThinkR-open/fusen/issues/163