-
Notifications
You must be signed in to change notification settings - Fork 14
[Query] Project
This document was generated from 'src/documentation/wiki-query.ts' on 2026-07-20, 13:05:03 UTC presenting an overview of flowR's query API (v2.12.3). Please do not edit this file/wiki page directly.
Project Query [overview]
Returns information about the analyzed project
This query is requested with the type project.
This query returns the information about the analyzed project. If present, it will incorporate plugins to, e.g., extract author and license information from R package DESCRIPTION files.
[ { "type": "project" } ](This can be shortened to @project when used with the REPL command :query).
Results (prettified and summarized):
Query: project (0 ms)
╰ Kind: unknown
╰ Dataflow not performed (run :df#, then re-run this query, or pass "withDf": true)
All queries together required ≈0 ms (1ms accuracy, total 0 ms)
Show Detailed Results as Json
The analysis required 0.5 ms (including parsing and normalization and the query) within the generation environment.
In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR. Please consult the Interface wiki page for more information on how to get those.
{
"project": {
".meta": {
"timing": 0
},
"files": [],
"roleCounts": {
"description": 0,
"namespace": 0,
"news": 0,
"vignette": 0,
"test": 0,
"install": 0,
"data": 0,
"license": 0,
"virtual-env": 0,
"manifest": 0,
"startup": 0,
"source": 0,
"other": 0
},
"kind": "unknown"
},
".meta": {
"timing": 0
}
}Original Code
x + 1Dataflow Graph of the R Code
The analysis required 1.5 ms (including parse and normalize, using the r-shell engine) within the generation environment. No signature database is mounted for these generated graphs, so library() calls attach no package exports; base-R names are still qualified via the generated base-package store (e.g. acf as stats::acf).
We encountered no unknown side effects during the analysis.
flowchart LR
0(["`*#91;RSymbol#93;* **x**
*1.1* (**id: 0**)`"])
%% No edges found for 0
1{{"`*#91;RNumber#93;* **1**
*1.5* (**id: 1**)`"}}
%% No edges found for 1
2[["`*#91;RBinaryOp#93;* base#58;#58;**#43;**
*1.1-5* (**id: 2**)
arg: (0, 1)`"]]
built-in:_["`Built-In:
#43;`"]
style built-in:_ stroke:gray,fill:gray,stroke-width:2px,opacity:.8;
2 -->|"reads, arg"| 0
2 -->|"reads, arg"| 1
2 -.->|"reads, calls"| built-in:_
linkStyle 2 stroke:gray;
Implementation Details
Responsible for the execution of the Project Query query is executeDataflowQuery in ./src/queries/catalog/project-query/project-query-executor.ts.
Currently maintained by Florian Sihler and Oliver Gerstl at Ulm University
Email | GitHub | Penguins | Portfolio
- 🧑💻 Developer Onboarding
- 💻 Setup
- 👓 Overview
- 🪟 Interfacing with flowR
- 🌋 Core
- 🧹 Testing & Linting (Benchmark Page)
⁉️ FAQ- ℹ️ Extra Information