Class FlowrAnalyzerMetaRProjectFilePlugin

Readonlytype

Readonlyversion

StaticdefaultPlugin

• defaultPlugin(): FlowrAnalyzerPackageVersionsPlugin

  Returns a default/dummy implementation to be used when no plugin of this type is registered or triggered.

  Returns FlowrAnalyzerPackageVersionsPlugin

addDatabaseSource

• addDatabaseSource(_source: string): Promise<void>

  Mount an extra signature source by path (a .sigs.ndjson, .br, or *.manifest.json(.br)); no-op by default.

  Parameters

  • _source: string

  Returns Promise<void>

loadedDatabases

• loadedDatabases(): SigDbLoadedInfo[]

  metadata of the databases this plugin currently has loaded (empty for plugins without any)

  Returns SigDbLoadedInfo[]

packagesExporting

• packagesExporting(_name: BrandedIdentifier): readonly BrandedNamespace[]

  Packages known to this plugin that export name (empty for plugins without a database).

  Parameters

  • _name: BrandedIdentifier

  Returns readonly BrandedNamespace[]

preloadDatabasesSync

• preloadDatabasesSync(): void

  Eagerly parse and mount this plugin's databases up front (no-op for plugins without any).

  Returns void

prepare

• prepare(_ctx: FlowrAnalyzerContext, _ast: NormalizedAst): Promise<void>

  Runs once the code is normalized and before its dataflow is built, the one point where a plugin may wait (on the network, say) for what the dataflow will ask of it, as the lookups during the dataflow are synchronous. No-op by default.

  Parameters

  • _ctx: FlowrAnalyzerContext
  • _ast: NormalizedAst

  Returns Promise<void>

process

• process(ctx: FlowrAnalyzerContext): void

  Parameters

  • ctx: FlowrAnalyzerContext

  Returns void

processor

• processor(context: FlowrAnalyzerContext, args: undefined): void

  Run the plugin with the given context and arguments.

  Parameters

  • context: FlowrAnalyzerContext
  • args: undefined

  Returns void

providesBaseRPackages

• providesBaseRPackages(): boolean

  Whether this plugin can resolve the always-available base-R packages (so their exports can be attached eagerly for bare base calls). false for plugins without a versioned base-R signature source.

  Returns boolean

signatureSources

• signatureSources(_config?: FlowrConfig): readonly PackageSignatureSource[]

  The signature sources this plugin currently has loaded (empty for plugins without any). config lets a query resolve config-driven sources before any analysis has set the plugin's context.

  Parameters

  • Optional_config: FlowrConfig

  Returns readonly PackageSignatureSource[]