Guppy Basecalling 软件
使用方法
使用配置文件:
guppy_basecaller-i <输入路径> -s <保存路径> -c <配置文件> [选项]
使用 flowcell 和 kit 名称:
guppy_basecaller -i <输入路径> -s <保存路径> --flowcell <flowcell名称>
--kit <kit名称>
列出支持的 flowcells 和 kits:
guppy_basecaller --print_workflows
使用 GPU 进行 basecalling:
guppy_basecaller -i <输入路径> -s <保存路径> -c <配置文件>
--device <cuda设备名称> [选项]
命令行参数
-c, --config
: 应用程序的配置文件。-d, --data_path
: 加载应用程序所需的任何数据文件的路径。-x, --device
: 指定 GPU 设备:‘auto’ 或 ‘cuda:<设备ID>’。-s, --save_path
: 保存输出文件的路径。--ping_url
: 发送 pings 的 URL。--trace_domains_config
: 包含要在详细日志中包含的 trace 域列表的配置文件(如果启用)。--progress_stats_frequency
: 如果提供,将替换默认进度显示,以秒为单位报告进度统计的频率。--ping_segment_duration
: 每个 ping 段的持续时间(分钟)。-z, --quiet
: 安静模式。如果设置此选项,则不会向 STDOUT 输出任何内容。--verbose_logs
: 启用详细日志。--disable_pings
: 禁用遥测 pings 的传输。-h, --help
: 显示应用程序使用帮助。-v, --version
: 显示应用程序版本信息。--trace_category_logs
: 启用 trace 日志 - 列出所需的名称字符串列表。-r, --recursive
: 递归搜索输入文件。-i, --input_path
: 输入文件的路径。--input_file_list
: 可选文件,包含从 input_path 处理的输入 fast5/pod5 文件列表。-l, --read_id_list
: 包含要过滤的读取 ID 列表的文件。--sample_sheet
: 可选文件,包含样本表。用于为条形码结果提供别名。--read_batch_size
: 最大批量大小,以读取为单位,用于分组输入文件。--nested_output_folder
: 如果标记,FastQ/BAM 文件将被写入基于以下结构的嵌套文件夹:protocol_group/sample/protocol/qscore_pass_fail/barcode_arrangement/--barcode_nested_output_folder
: 如果标记,FastQ/BAM 文件将被写入基于以下结构的嵌套文件夹:protocol_group/barcode_arrangement/sample/protocol/qscore_pass_fail/--fast5_out
: 是否进行 fast5 输出的选择。--resume
: 使用相同的输出文件夹恢复先前的 basecall 运行。-q, --records_per_fastq
: 每个 fastq 文件的最大记录数,0 表示使用单个文件(每次运行 ID,每次批量)。--bam_methylation_threshold
: 预测的甲基化概率不会在 BAM 文件中发出的值,以百分比表示。--compress_fastq
: 使用 gzip 压缩 fastq 输出文件。--bam_out
: 输出 BAM 文件。--index
: 输出 BAM 索引文件。--moves_out
: 在输出 BAM 文件中返回移动表。--max_queued_reads
: 输入队列中的最大读取数。--trim_threshold
: 数据将被修剪的阈值(当前级别分布的标准偏差)。--trim_min_events
: 适配器修剪器在停滞后必须看到的最小步长间隔。--max_search_len
: 搜索停滞的最大样本数。--override_scaling
: 手动提供缩放参数,而不是从每个读取中估计它们。--scaling_med
: 用于手动缩放的中位数电流值。--scaling_mad
: 用于手动缩放的中位数绝对偏差。--trim_strategy
: 应用的修剪策略:‘dna’ 或 ‘rna’(或 ‘none’ 以禁用修剪)。--dmean_win_size
: 粗略停滞事件检测的窗口大小。--dmean_threshold
: 粗略停滞事件检测的阈值。--jump_threshold
: RNA 停滞检测的阈值级别。--pt_scaling
: 启用 polyT/adapter 最大检测以进行读取缩放。--pt_median_offset
: 设置用于设置读取缩放中位数的 polyT 中位数偏移。--adapter_pt_range_scale
: 设置用于设置读取缩放中位数绝对偏差的 polyT/adapter 范围缩放。--pt_required_adapter_drop
: 设置从 adapter 最大值到 polyT 检测所需的最小电流下降。--pt_minimum_read_start_index
: 设置尝试 polyT 缩放所需的读取起始样本的最小索引。--as_model_file
: 用于适配器缩放的 JSON 模型文件路径。--as_gpu_runners_per_device
: 每个 GPU 设备的运行器数量,用于适配器缩放。--as_cpu_threads_per_scaler
: 每个适配器缩放器的 CPU 工作线程数量。--as_reads_per_runner
: 适配器缩放中每个运行器的最大读取数。--as_num_scalers
: 适配器缩平的并行缩放器数量。--noisiest_section_scaling_max_size
: 阈值读取大小(样本),在此大小以下将执行最嘈杂部分缩放。-m, --model_file
: JSON 模型文件的路径。-k, --kernel_path
: GPU 内核文件的位置(仅当 builtin_scripts 为 false 时需要)。--builtin_scripts
: 是否使用在编译时包含的 GPU 内核。--chunk_size
: 每个块的步长间隔。--chunks_per_runner
: 每个运行器的最大块数。--chunks_per_caller
: 每个调用者的队列中的块数软限制。当超过此限制时,新的读取将不会被排队。--high_priority_threshold
: 每个中等优先级块要处理的高优先级块数。--medium_priority_threshold
: 每个低优先级块要处理的中等优先级块数。--overlap
: 块之间的重叠(步长间隔)。--gpu_runners_per_device
: 每个 GPU 设备的运行器数量。--cpu_threads_per_caller
: 每个 basecaller 的 CPU 工作线程数量。--num_callers
: 要创建的并行 basecallers 数量。--num_base_mod_threads
: 在 GPU basecalling 模式中用于 Remora 修改基检测的线程数量。--post_out
: 在输出 fast5 文件和/或从服务器调用读取消息中返回完整的后验矩阵。--stay_penalty
: 在 transducer 解码期间,应用于停留概率计算的缩放因子。--qscore_offset
: Qscore 校准偏移量。--qscore_scale
: Qscore 校准比例因子。--temp_weight
: RNN softmax 层中权重矩阵的温度调整。--temp_bias
: RNN softmax 层中偏置向量的温度调整。--beam_cut
: 束搜索解码的束分数截止。--beam_width
: 束搜索解码的束分数截止。--duplex_window_size_min
: 在双链解码中用于前缀搜索的最小窗口大小。--duplex_window_size_max
: 在双链解码中用于前缀搜索的最大窗口大小。--disable_qscore_filtering
: 禁用基于最小 qscore 对读取进行 PASS/FAIL 文件夹的过滤。--min_qscore
: 将读取过滤到 PASS 文件夹的最小可接受 qscore。--reverse_sequence
: 反转调用的序列(用于 RNA 测序)。--u_substitution
:在调用的序列中用 ‘U’ 替换 ‘T’(用于 RNA 测序)。--log_speed_frequency
: 打印 basecalling 速度的频率。--int8_mode
: 启用支持它的内核的量化 int8 模式。--barcode_kits
: 要检测的条形码套件(s)或扩展套件(s)的空格分隔列表。必须用双引号括起来。--disable_trim_barcodes
: 禁用从输出文件中的序列修剪条形码。默认情况下为 false,将修剪条形码。--trim_adapters
: 从输出文件中的序列修剪适配器。--trim_primers
: 从输出文件中的序列修剪引物。--num_extra_bases_trim
: 修剪条形码的强度。默认为 0,即检测到的条形码的长度。正整数意味着将修剪额外的碱基,负数是修剪较少的碱基(不那么积极)。--min_score_barcode_front
: 考虑前端条形码为有效条形码对齐的最小分数。--min_score_barcode_rear
: 考虑后端条形码为有效对齐的最小分数(并设置 min_score_front 仅用于前端,当此设置时)。--min_score_barcode_mask
: 考虑条形码上下文为有效对齐的最小分数。--min_score_adapter
: 考虑适配器为有效对齐的最小分数。--min_score_primer
: 考虑引物为有效对齐的最小分数。--min_score_adapter_mid
: 考虑中间链适配器为有效对齐的最小分数。--min_score_barcode_mid
: 考虑在读取中间检测到条形码的最小分数。--front_window_size
: 起始条形码的窗口大小。--rear_window_size
: 结束条形码的窗口大小。--require_barcodes_both_ends
: 只有在读取的两端都有高于 min_score 的条形码时,读取才会被分类。--allow_inferior_barcodes
: 即使前端和后端(如果适用)的条形码都不是高于 min_score 的最佳得分条形码,读取仍将被分类。--detect_barcodes
: 在读取的前端和后端检测条形码序列。--detect_adapter
: 在读取的前端和后端检测适配器序列。--detect_primer
: 在读取的前端和后端检测引物序列。--detect_mid_strand_barcodes
: 通过整个读取长度搜索条形码。--detect_mid_strand_adapter
: 在读取中检测适配器序列。--num_barcoding_buffers
: 分配给执行条形码的 GPU 内存缓冲区数量。控制 GPU 上条形码的并行级别。--num_mid_barcoding_buffers
: 分配给执行条形码的 GPU 内存缓冲区数量。控制 GPU 上中间条形码的并行级别。--num_barcoding_threads
: 用于条形码的工作者线程数量。--num_reads_per_barcoding_buffer
: 每个条形码缓冲区一次处理的最大读取数。--lamp_kit
: 执行 LAMP 检测的 LAMP 条形码套件。--min_score_lamp
: 将 LAMP 条形码分类的最小分数。--min_score_lamp_mask
: 将 LAMP 条形码掩码上下文分类的最小分数。--min_score_lamp_target
: 将 LAMP 目标分类的最小分数。--min_length_lamp_context
: 将 LAMP 条形码掩码上下文分类的最小对齐长度。--min_length_lamp_target
: 将 LAMP 目标分类的最小对齐长度。--additional_lamp_context_bases
: 从 lamp FIP 条形码上下文中附加到 FIP 条形码前面和后面的碱基数量。默认为 2。--num_read_splitting_buffers
: 分配给执行读取分割的 GPU 内存缓冲区数量。控制 GPU 上使用中间适配器检测进行读取分割的并行级别。--num_read_splitting_threads
: 用于读取分割的工作者线程数量。--min_score_read_splitting
: 基于中间适配器检测分割读取的最小对齐分数。--do_read_splitting
: 基于中间链适配器检测执行读取分割。--max_read_split_depth
: 应执行的读取分割的最大迭代次数。--calib_reference
: 包含校准链的参考 FASTA 文件。--calib_detect
: 启用校准链检测和过滤。-a, --align_ref
: 参考 FASTA 或索引文件。--bed_file
: 包含参考基因组中感兴趣区域的 .bed 文件路径。--align_type
: 指定您是否需要完整对齐或粗略对齐。有效值为 (auto/full/coarse)。--minimap_opt_string
: 指定 minimap2 选项。详细信息见 guppy_basecaller --minimap_opt_string --help
。--num_alignment_threads
: 用于对齐的工作者线程数量。--print_workflows
: 输出可用的工作流。--flowcell
: 寻找配置的 flowcell。--kit
: 寻找配置的 kit。