diff --git a/src/documentation/data/faq/faqs.ts b/src/documentation/data/faq/faqs.ts index 59e2b483779..aa59bb9e91d 100644 --- a/src/documentation/data/faq/faqs.ts +++ b/src/documentation/data/faq/faqs.ts @@ -47,7 +47,7 @@ Check out the [Logging Section in the Linting and Testing wiki page](${FlowrWiki .addFaq('How to *query* an R project?', ` For this you can use flowR's [Query API](${FlowrWikiBaseRef}/Query-API). If you want to create your own project using flowR as a library, check out the -[${FlowrGithubGroupName}/query-project-sample](${FlowrGithubBaseRef}/query-project-sample) repository for an example project setup. +[${FlowrGithubGroupName}/sample-analyzer-project-query](${FlowrGithubBaseRef}/sample-analyzer-project-query) repository for an example project setup. `); wikiFaq.withTopic('r.packages') diff --git a/src/documentation/print-analyzer-wiki.ts b/src/documentation/print-analyzer-wiki.ts index 6df03361f28..1ba8372f947 100644 --- a/src/documentation/print-analyzer-wiki.ts +++ b/src/documentation/print-analyzer-wiki.ts @@ -87,7 +87,7 @@ ${printCodeOfElement({ program: types.program, info: types.info, dropLinesStart: In general, we work on providing a set of example repositories that demonstrate how to use the analyzer in different scenarios: -* [${FlowrGithubGroupName}/query-project-sample](${FlowrGithubBaseRef}/query-project-sample) for an example project that runs queries on an R project +* [${FlowrGithubGroupName}/sample-analyzer-project-query](${FlowrGithubBaseRef}/sample-analyzer-project-query) for an example project that runs queries on an R project **TODO**: mention [Context](#Context_Information) diff --git a/src/documentation/print-dataflow-graph-wiki.ts b/src/documentation/print-dataflow-graph-wiki.ts index d1b9424b78a..080eacd6bf5 100644 --- a/src/documentation/print-dataflow-graph-wiki.ts +++ b/src/documentation/print-dataflow-graph-wiki.ts @@ -7,7 +7,7 @@ import { edgeIncludesType, EdgeType, edgeTypeToName, splitEdgeTypes } from '../d import { DataflowGraphBuilder, emptyGraph } from '../dataflow/graph/dataflowgraph-builder'; import { guard } from '../util/assert'; import { formatSideEffect, printDfGraph, printDfGraphForCode, verifyExpectedSubgraph } from './doc-util/doc-dfg'; -import { FlowrGithubBaseRef, FlowrWikiBaseRef, getFilePathMd } from './doc-util/doc-files'; +import { FlowrGithubBaseRef, FlowrGithubGroupName, FlowrWikiBaseRef, getFilePathMd } from './doc-util/doc-files'; import { requestFromInput } from '../r-bridge/retriever'; import { jsonReplacer } from '../util/json'; import { printEnvironmentToMarkdown } from './doc-util/doc-env'; @@ -250,8 +250,6 @@ These origins may hold the name of any processor that is part of the ${shortLink The entry \`function\` signals that flowR used a processor for a user-defined function defined within the source code, \`unnamed\` signals that the function as an anonymous function definition. However, in general, flowR may use any fitting handler as an origin. For example, within a access definition, flowR will correspondingly redefine the meaning of \`:=\` to that of the \`table:assign\`. - - ${ details('Example: Simple Function Call (unresolved)', await (async() => { @@ -911,6 +909,8 @@ wiki page if you are unsure. > When using _flowR_ as a library, you may use the functions in ${getFilePathMd('../util/mermaid/dfg.ts')}. > > If you receive a dataflow graph in its serialized form (e.g., by talking to a [_flowR_ server](${FlowrWikiBaseRef}/Interface)), you can use ${shortLink(`${DataflowGraph.name}::${DataflowGraph.fromJson.name}`, vertexType.info, true, 'i')} to retrieve the graph from the JSON representation. +> +> Also, check out the [${FlowrGithubGroupName}/sample-analyzer-df-diff](${FlowrGithubBaseRef}/sample-analyzer-df-diff) repository for a complete example project creating and comparing dataflow graphs. ${await printDfGraphForCode(shell,'x <- 3\ny <- x + 1\ny')} diff --git a/src/documentation/print-query-wiki.ts b/src/documentation/print-query-wiki.ts index 98c7353be4d..cca745fca42 100644 --- a/src/documentation/print-query-wiki.ts +++ b/src/documentation/print-query-wiki.ts @@ -760,7 +760,7 @@ There are many ways to query a dataflow graph created by flowR. For example, you can use the [\`request-query\`](${FlowrWikiBaseRef}/Interface#message-request-query) message with a running flowR server, or the ${getReplCommand('query')} command in the flowR [REPL](${FlowrWikiBaseRef}/Interface#repl). -Also, check out the [${FlowrGithubGroupName}/query-project-sample](${FlowrGithubBaseRef}/query-project-sample) repository for a complete example project using the query API. +Also, check out the [${FlowrGithubGroupName}/sample-analyzer-project-query](${FlowrGithubBaseRef}/sample-analyzer-project-query) repository for a complete example project using the query API. `.trim() }) } diff --git a/wiki/Analyzer.md b/wiki/Analyzer.md index e1b8471cfbd..20949d6f6ee 100644 --- a/wiki/Analyzer.md +++ b/wiki/Analyzer.md @@ -49,7 +49,7 @@ what [Engine](https://github.com/flowr-analysis/flowr/wiki/Engines) to use for t In general, we work on providing a set of example repositories that demonstrate how to use the analyzer in different scenarios: -* [flowr-analysis/query-project-sample](https://github.com/flowr-analysis/query-project-sample) for an example project that runs queries on an R project +* [flowr-analysis/sample-analyzer-project-query](https://github.com/flowr-analysis/sample-analyzer-project-query) for an example project that runs queries on an R project **TODO**: mention [Context](#Context_Information) diff --git a/wiki/FAQ.md b/wiki/FAQ.md index db25d1a5565..2f2381bf296 100644 --- a/wiki/FAQ.md +++ b/wiki/FAQ.md @@ -94,7 +94,7 @@ npm run flowR -- --help For this you can use flowR's [Query API](https://github.com/flowr-analysis/flowr/wiki/Query-API). If you want to create your own project using flowR as a library, check out the -[flowr-analysis/query-project-sample](https://github.com/flowr-analysis/query-project-sample) repository for an example project setup. +[flowr-analysis/sample-analyzer-project-query](https://github.com/flowr-analysis/sample-analyzer-project-query) repository for an example project setup. diff --git a/wiki/Query API.md b/wiki/Query API.md index cb5fb682f6f..4923af32c1c 100644 --- a/wiki/Query API.md +++ b/wiki/Query API.md @@ -9,7 +9,7 @@ Please see the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interfac > For example, you can use the [`request-query`](https://github.com/flowr-analysis/flowr/wiki/Interface#message-request-query) message > with a running flowR server, or the `:query` command in the flowR [REPL](https://github.com/flowr-analysis/flowr/wiki/Interface#repl). > -> Also, check out the [flowr-analysis/query-project-sample](https://github.com/flowr-analysis/query-project-sample) repository for a complete example project using the query API. +> Also, check out the [flowr-analysis/sample-analyzer-project-query](https://github.com/flowr-analysis/sample-analyzer-project-query) repository for a complete example project using the query API. ## The Query Format