Data files, e.g., R/sysdata.rda, currently not specially supported.
The DESCRIPTION file in R packages, this is the only currently supported special file.
Environment-variable definitions read at startup (.Renviron, Renviron.site). These are KEY=value
files, not R source, so they are labeled but not parsed as R.
Files below an inst/ folder, which R installs verbatim into the package root (resources/scripts, e.g., inst/REFERENCES.R, inst/CITATION, inst/extdata/...).
These are not part of the package namespace source, so tooling may want to treat them separately.
Signals separate license files, but please note, that DESCRIPTION files may contain license info too
A project manifest that is no DESCRIPTION, e.g. the rproject.toml of an rv project.
The NAMESPACE file in R packages, currently not specially supported.
The NEWS file in R packages
Other special files that are not specifically supported by flowR but may be interesting for some analyses.
Catch-all for any file that provides usable R source code to incorporate into the analysis. Please note, that the loading order/inclusion and even potential relevance of these source files is determined by the loading order plugins (cf. PluginType.LoadingOrder) in the FlowrAnalyzerLoadingOrderContext.
R sources evaluated at startup, before any project code (.Rprofile, Rprofile.site).
These commonly bootstrap a package manager, e.g. by sourcing packrat/init.R or renv/activate.R.
Test source files, e.g., files in the tests/ folder
Vignette files, e.g., R Markdown files in the vignettes/ folder
Files describing a project's virtual/pinned package environment, e.g., renv.lock or rv.lock.
Some files have a special meaning in R projects, e.g., the
DESCRIPTIONfile in R packages. This list may be extended in the future and reflects files that the FlowrAnalyzer can do something interesting with. If you add an interesting file that is only part of your plugin infrastructure, please use theotherrole.