Package: fusen 0.7.2

Vincent Guyader

fusen: Build a Package from Rmarkdown Files

Use Rmarkdown First method to build your package. Start your package with documentation, functions, examples and tests in the same unique file. Everything can be set from the Rmarkdown template file provided in your project, then inflated as a package. Inflating the template copies the relevant chunks and sections in the appropriate files required for package development.

Authors:Sebastien Rochette [aut], Vincent Guyader [aut, cre], Yohann Mansiaux [aut], ThinkR [cph]

fusen_0.7.2.tar.gz
fusen_0.7.2.zip(r-4.7)fusen_0.7.2.zip(r-4.6)fusen_0.7.2.zip(r-4.5)
fusen_0.7.2.tgz(r-4.6-any)fusen_0.7.2.tgz(r-4.5-any)
fusen_0.7.2.tar.gz(r-4.7-any)fusen_0.7.2.tar.gz(r-4.6-any)
fusen_0.7.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
fusen/json (API)

# Install 'fusen' in R:
install.packages('fusen', repos = c('https://thinkr-open.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/thinkr-open/fusen/issues

Pkgdown/docs site:https://thinkr-open.github.io

On CRAN:

Conda:

hacktoberfestrmd-first

8.40 score 173 stars 29 scripts 372 downloads 24 exports 101 dependencies

Last updated from:6034686011. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK327
source / vignettesOK216
linux-release-x86_64OK321
macos-release-arm64OK445
macos-oldrel-arm64OK237
windows-develOK354
windows-releaseOK308
windows-oldrelOK315
wasm-releaseOK140

Exports:%>%add_additionaladd_dev_historyadd_flat_templateadd_fulladd_fusen_chunksadd_minimal_flatadd_minimal_packagecheck_not_registered_filescreate_fusendeprecate_flat_filedraw_package_structurefill_descriptionget_all_created_funsget_package_structureinflateinflate_allinflate_all_no_checkinit_share_on_githublist_flat_filesload_flat_functionsregister_all_to_configrename_flat_filesepuku

Dependencies:askpassattachmentbase64encbrewbriobslibcachemcallrclicliprcommonmarkcpp11crayoncredentialscurldescdevtoolsdiffobjdigestdownlitdplyrellipsisevaluatefansifastmapfontawesomefsgenericsgertgitcredsglueherehighrhtmltoolshtmlwidgetshttpuvhttr2inijquerylibjsonliteknitrlaterlifecyclelightparsermagrittrmemoisemimeminiUIopensslotelpakpillarpkgbuildpkgconfigpkgdownpkgloadpraiseprettyunitsprocessxprofvispromisespspurrrR6raggrappdirsrcmdcheckRcpprlangrmarkdownroxygen2rprojrootrstudioapirversionssasssessioninfoshinysourcetoolsstringistringrsyssystemfontstestthattextshapingtibbletidyrtidyselecttinytexurlcheckerusethisutf8vctrswaldowhiskerwithrxfunxml2xopenxtableyamlzip

Deal with a 'fusen' flat file
Rename a flat file | Fully deprecate a flat file after inflate

Last update: 2025-01-30
Started: 2024-05-03

Switch from a package developed with fusen to a classical package
Move from a package developed with fusen to a "classical" package

Last update: 2025-01-30
Started: 2024-06-10

Tips and tricks
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 pre-fill multiple functions in one template | How to inflate multiple flat files ? | How to store multiple functions in a unique R file ? | All functions under one title section | Use same @rdname in function roxygen | Use same @filename in function roxygen | Use chunk param filename = "the_comon_filename" | How to read dataset that I usually put in "tests/testthat/" for my unit tests? | Can I load all functions of the current flat file during development without having to inflate()? | Can I inflate a Quarto qmd file? | Can I use {fusen} with {golem}? | How can I know if R files were created from a flat or not ? | How can I get rid of everything related to 'fusen' in my package ?

Last update: 2025-01-30
Started: 2021-12-16

Draw a tree of your package files and functions
Get a tree of the package structure to help developers | Get the list of functions from a R file

Last update: 2024-06-17
Started: 2024-05-13

Register files in config
{fusen} registers all files of your package | What is the configuration file? | What about unregistered files? | Deprecate flat files after inflate | Detect all files that are not registered in configuration file | How register_all_to_config() works

Last update: 2024-06-17
Started: 2023-06-08

Inflate all your flat files
Inflate all your flat files at once | Store configuration of each flat file once | Prevent some flat files to be inflated | Wrapper around inflate_all() | Register all other files to help clean your project | Compute the code coverage | Complete the process with your own code style

Last update: 2024-06-17
Started: 2023-04-19

Maintain packages with {fusen}
Daily use of | Add a new set of chunks in the current Rmd | Create a new flat Rmd template | How to maintain a {fusen}? Can I use {fusen} with old-way packages ? | Option 1: Continue with the "flat_template.Rmd" | Option 2: Maintain like a classical package | What about packages already built the old way ? | Let's try to convince package developers with an example | Compare a classical way of building packages with the {fusen} way

Last update: 2024-05-13
Started: 2021-04-07

Share on a GitHub website
Initiate your package and share it on GitHub | What happens behind the scene ?

Last update: 2024-05-13
Started: 2022-10-28

How to use fusen
All steps to create a package with {fusen} from one Rmd file | Fill your package Description | Inflate your package from the flat Rmd template | Create a new package from command line directly, using a pre-defined template | Add a new "flat_template.Rmd" template in "dev/" directory | There can be development actions | Limitations

Last update: 2024-05-07
Started: 2021-04-07