The flames from youyupei

flames's People

Contributors

flames's Issues

Update the vignette of `create_config` function (Copied to the org repo)

The vignette for the create_config() function is currently out-of-date.

create_config              package:FLAMES              R Documentation

Create Configuration File From Arguments

Description:

     Create Configuration File From Arguments

Usage:

     create_config(outdir, type = "sc_3end", ...)
     
Arguments:

  outdir: the destination directory for the configuratio nfile

    type: use an example config, available values:

            • "sc_3end" - config for 10x 3' end ONT reads

            • "SIRV" - config for the SIRV example reads

     ...: Configuration parameters.

            • do_genome_align - Boolean. Specifies whether to run the
              genome alignment step. 'TRUE' is recommended

            • do_isoform_id - Boolean. Specifies whether to run the
              isoform identification step. 'TRUE' is recommended
     
            ...

Users could still use the function to generate a configuration file. However, only the outdir and type arguments are in effect. To modify other options, users have to edit the configuration file generated manually.

Recommend Projects