@eagleoutice/flowr - v2.10.1
    Preparing search index...
    • Creates a wiki context for generating documentation for code elements. This context provides methods to create links, code snippets, and documentation for code elements.

      Parameters

      • Optionalshell: RShell

        An optional RShell instance to retrieve the R version for the auto-generation header.

      • ...rootFolders: string[]

        The root folder(s) of the code base to analyze. Defaults to flower's src/ and test/ folder.

      Returns GeneralDocContext

      const ctx = makeContextForTypes();
      const linkToFn = ctx.link('myFunction');
      const fnDoc = ctx.doc('myFunction');