Method getKnitCommand

src/rmarkdown/knit.ts:130–159

(yamlParams: IYamlFrontmatter, docPath: string, outputFormat?: string)

    }

    private async getKnitCommand(yamlParams: IYamlFrontmatter, docPath: string, outputFormat?: string): Promise<string | undefined> {
        let knitCommand: string;

        if (!yamlParams?.['site']) {
            yamlParams['site'] = await this.findSiteParam();
        }

        // precedence:
        // knit > site > configuration
        if (yamlParams?.['knit']) {
            const knitParam = yamlParams['knit'].trim();
            knitCommand = outputFormat ?
                `${knitParam}(${docPath}, output_format = '${outputFormat}')` :
                `${knitParam}(${docPath})`;
        } else if (!this.isREADME(docPath) && yamlParams?.['site']) {
            knitCommand = outputFormat ?
                `rmarkdown::render_site(${docPath}, output_format = '${outputFormat}')` :
                `rmarkdown::render_site(${docPath})`;
        } else {
            const cmd = util.config().get<string>('rmarkdown.knit.command');
            if (!cmd) {
                return;
            }
            knitCommand = outputFormat ?
                `${cmd}(${docPath}, output_format = '${outputFormat}')` :
                `${cmd}(${docPath})`;
        }

        return knitCommand.replace(/['"]/g, '\'');
    }

    // check if the workspace of the document is a R Markdown site.
    // the definition of what constitutes an R Markdown site differs