diff --git a/pybwa/libbwaaln.pyx b/pybwa/libbwaaln.pyx index 7326278..41701ca 100644 --- a/pybwa/libbwaaln.pyx +++ b/pybwa/libbwaaln.pyx @@ -18,7 +18,7 @@ __all__ = [ ] cdef class BwaAlnOptions: - """The container for options for [`BwaAln`][pybwa.BwaAln].""" + """The container for options for :class:`pybwa.BwaAln.""" cdef gap_opt_t * _delegate _max_hits: int @@ -42,14 +42,14 @@ cdef class BwaAlnOptions: self._delegate.s_mm = value property max_gap_opens: - """bwa aln -o """ + """:code:`bwa aln -o `""" def __get__(self): return self._delegate.max_gapo def __set__(self, value: int): self._delegate.max_gapo = value property max_gap_extensions: - """bwa aln -e """ + """:code:`bwa aln -e `""" def __get__(self): return self._delegate.max_gapo def __set__(self, value: int): @@ -58,56 +58,56 @@ cdef class BwaAlnOptions: self._delegate.mode &= ~BWA_MODE_GAPE property min_indel_to_end_distance: - """bwa aln -i """ + """:code:`bwa aln -i `""" def __get__(self): return self._delegate.indel_end_skip def __set__(self, value: int): self._delegate.indel_end_skip = value property max_occurrences_for_extending_long_deletion: - """bwa aln -d """ + """:code:`bwa aln -d `""" def __get__(self): return self._delegate.max_del_occ def __set__(self, value: int): self._delegate.max_del_occ = value property seed_length: - """bwa aln -l """ + """:code:`bwa aln -l `""" def __get__(self): return self._delegate.seed_len def __set__(self, value: int): self._delegate.seed_len = value property max_mismatches_in_seed: - """bwa aln -k """ + """:code:`bwa aln -k `""" def __get__(self): return self._delegate.max_seed_diff def __set__(self, value: int): self._delegate.max_seed_diff = value property mismatch_penalty: - """bwa aln -M """ + """:code:`bwa aln -M `""" def __get__(self): return self._delegate.s_mm def __set__(self, value: int): self._delegate.s_mm = value property gap_open_penalty: - """bwa aln -O """ + """:code:`bwa aln -O `""" def __get__(self): return self._delegate.s_gapo def __set__(self, value: int): self._delegate.s_gapo = value property gap_extension_penalty: - """bwa aln -E """ + """:code:`bwa aln -E `""" def __get__(self): return self._delegate.s_gape def __set__(self, value: int): self._delegate.s_gape = value property stop_at_max_best_hits: - """bwa aln -R """ + """:code:`bwa aln -R `""" def __get__(self): return self._delegate.max_top2 def __set__(self, value: int): @@ -121,7 +121,7 @@ cdef class BwaAlnOptions: self._max_hits = value property log_scaled_gap_penalty: - """bwa aln -L""" + """:code:`bwa aln -L`""" def __get__(self): return self._delegate.mode & BWA_MODE_LOGGAP > 0 def __set__(self, value: int): @@ -132,7 +132,7 @@ cdef class BwaAlnOptions: cdef class BwaAln: - """The class to align reads with `bwa aln`.""" + """The class to align reads with :code:`bwa aln`.""" cdef BwaIndex _index diff --git a/pybwa/libbwaindex.pyx b/pybwa/libbwaindex.pyx index 018a343..86144ff 100644 --- a/pybwa/libbwaindex.pyx +++ b/pybwa/libbwaindex.pyx @@ -34,7 +34,11 @@ cdef bytes force_bytes_with(object s, encoding: str | None = None, errors: str | cdef class BwaIndex: - """Contains the index and nucleotide sequence for Bwa. + """Contains the index and nucleotide sequence for Bwa. Use :code:`bwa index` on the command + line to generate the bwa index. + + Note: the accompanying sequence dictionary must exist (i.e. `.dict` file, which can be generated + with :code:`samtools dict `). Args: prefix (str | Path): the path prefix for teh BWA index diff --git a/pybwa/libbwamem.pyx b/pybwa/libbwamem.pyx index f6cc882..149ecfd 100644 --- a/pybwa/libbwamem.pyx +++ b/pybwa/libbwamem.pyx @@ -26,7 +26,7 @@ class BwaMemMode(enum.Enum): cdef class BwaMemOptions: - """The container for options for [`BwaMem`][pybwa.BwaMem].""" + """The container for options for :class:`~pybwa.BwaMem`.""" _ignore_alt: bool _mode: BwaMemMode | None cdef mem_opt_t* _options @@ -46,117 +46,117 @@ cdef class BwaMemOptions: return self._options property min_seed_len: - """bwa mem -k """ + """:code:`bwa mem -k `""" def __get__(self): return self._options.min_seed_len property mode: - """bwa mem -x """ + """:code:`bwa mem -x `""" def __get__(self) -> BwaMemMode: return self._mode property band_width: - """bwa mem -w """ + """:code:`bwa mem -w `""" def __get__(self): return self._options.w property match_score: - """bwa mem -A """ + """:code:`bwa mem -A `""" def __get__(self): return self._options.a property mismatch_penalty: - """bwa mem -A """ + """:code:`bwa mem -A `""" def __get__(self): return self._options.b property minimum_score: - """bwa mem -T """ + """:code:`bwa mem -T `""" def __get__(self): return self._options.T property unpaired_penalty: - """bwa mem -U """ + """:code:`bwa mem -U `""" def __get__(self): return self._options.pen_unpaired property n_threads: - """bwa mem -t """ + """:code:`bwa mem -t `""" def __get__(self): return self._options.n_threads property skip_pairing: - """bwa mem -P""" + """:code:`bwa mem -P`""" def __get__(self): return (self._options.flag & MEM_F_NOPAIRING) != 0 property output_all_for_fragments: - """bwa mem -a""" + """:code:`bwa mem -a`""" def __get__(self): return (self._options.flag & MEM_F_ALL) != 0 property interleaved_paired_end: - """bwa mem -p""" + """:code:`bwa mem -p`""" def __get__(self): return (self._options.flag & (MEM_F_PE | MEM_F_SMARTPE)) != 0 property short_split_as_secondary: - """bwa mem -M""" + """:code:`bwa mem -M`""" def __get__(self): return (self._options.flag & MEM_F_NO_MULTI) != 0 property skip_mate_rescue: - """bwa mem -S""" + """:code:`bwa mem -S`""" def __get__(self): return (self._options.flag & MEM_F_NO_RESCUE) != 0 property soft_clip_supplementary: - """bwa mem -Y""" + """:code:`bwa mem -Y`""" def __get__(self): return (self._options.flag & MEM_F_SOFTCLIP) != 0 property with_xr_tag: - """bwa mem -V""" + """:code:`bwa mem -V`""" def __get__(self): return (self._options.flag & MEM_F_REF_HDR) != 0 property query_coord_as_primary: - """bwa mem -5""" + """:code:`bwa mem -5`""" def __get__(self): return (self._options.flag & (MEM_F_PRIMARY5 | MEM_F_KEEP_SUPP_MAPQ)) != 0 property keep_mapq_for_supplementary: - """bwa mem -q""" + """:code:`bwa mem -q`""" def __get__(self): return (self._options.flag & MEM_F_KEEP_SUPP_MAPQ) != 0 property with_xb_tag: - """bwa mem -u""" + """:code:`bwa mem -u`""" def __get__(self): return (self._options.flag & MEM_F_XB) != 0 property max_occurrences: - """bwa mem -c """ + """:code:`bwa mem -c `""" def __get__(self): return self._options.max_occ property off_diagonal_x_dropoff: - """bwa mem -d """ + """:code:`bwa mem -d `""" def __get__(self): return self._options.XA_drop_ratio property ignore_alternate_contigs: - """bwa mem -j""" + """:code:`bwa mem -j`""" def __get__(self): return self._ignore_alt property internal_seed_split_factor: - """bwa mem -r """ + """:code:`bwa mem -r `""" def __get__(self): return self._options.split_factor property drop_chain_fraction: - """bwa mem -D """ + """:code:`bwa mem -D `""" def __get__(self): return self._options.drop_ratio def __set__(self, value: float): @@ -164,32 +164,32 @@ cdef class BwaMemOptions: self._options0.drop_ratio = 1 property max_mate_rescue_rounds: - """bwa mem -m """ + """:code:`bwa mem -m `""" def __get__(self): return self._options.max_matesw property min_seeded_bases_in_chain: - """bwa mem -W """ + """:code:`bwa mem -W `""" def __get__(self): return self._options.min_chain_weight property seed_occurrence_in_3rd_round: - """bwa mem -y """ + """:code:`bwa mem -y `""" def __get__(self): return self._options.max_mem_intv property xa_max_hits: - """bwa mem -h >""" + """:code:`bwa mem -h >`""" def __get__(self): return self._options.max_XA_hits, self._options.max_XA_hits_alt property xa_drop_ratio: - """bwa mem -y """ + """:code:`bwa mem -y `""" def __get__(self): return self._options.XA_drop_ratio property gap_open_penalty: - """bwa mem -O >""" + """:code:`bwa mem -O >`""" def __get__(self): if self._options.o_del == self._options.o_ins: return self._options.o_del @@ -197,7 +197,7 @@ cdef class BwaMemOptions: return self._options.o_del, self._options.o_ins property gap_extension_penalty: - """bwa mem -E >""" + """:code:`bwa mem -E >`""" def __get__(self): if self._options.e_del == self._options.e_ins: return self._options.e_del @@ -206,7 +206,7 @@ cdef class BwaMemOptions: property clipping_penalty: - """bwa mem -L >""" + """:code:`bwa mem -L >`""" def __get__(self): if self._options.pen_clip5 == self._options.pen_clip3: return self._options.pen_clip5 @@ -216,7 +216,7 @@ cdef class BwaMemOptions: cdef class BwaMemOptionsBuilder(BwaMemOptions): - """The container for options for [`BwaMem`][pybwa.BwaMem].""" + """The container for options for :class:`~pybwa.BwaMem`.""" cdef mem_opt_t* _options0 def __init__(self, options: BwaMemOptions | None = None): @@ -301,7 +301,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): return self property min_seed_len: - """bwa mem -k """ + """:code:`bwa mem -k `""" def __get__(self): return super().min_seed_len def __set__(self, value: int): @@ -309,14 +309,14 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.min_seed_len = 1 property mode: - """bwa mem -x """ + """:code:`bwa mem -x `""" def __get__(self) -> BwaMemMode: return super().mode def __set__(self, value: BwaMemMode): self._mode = value property band_width: - """bwa mem -w """ + """:code:`bwa mem -w `""" def __get__(self): return super().band_width def __set__(self, value: int): @@ -324,7 +324,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.w = 1 property match_score: - """bwa mem -A """ + """:code:`bwa mem -A `""" def __get__(self): return super().match_score def __set__(self, value: int): @@ -332,7 +332,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.a = 1 property mismatch_penalty: - """bwa mem -A """ + """:code:`bwa mem -A `""" def __get__(self): return super().mismatch_penalty def __set__(self, value: int): @@ -340,7 +340,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.b = 1 property minimum_score: - """bwa mem -T """ + """:code:`bwa mem -T `""" def __get__(self): return super().minimum_score def __set__(self, value: int): @@ -348,7 +348,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.T = 1 property unpaired_penalty: - """bwa mem -U """ + """:code:`bwa mem -U `""" def __get__(self): return super().unpaired_penalty def __set__(self, value: int): @@ -356,7 +356,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.pen_unpaired = 1 property n_threads: - """bwa mem -t """ + """:code:`bwa mem -t `""" def __get__(self): return super().n_threads def __set__(self, value: int): @@ -370,77 +370,77 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): return self property skip_pairing: - """bwa mem -P""" + """:code:`bwa mem -P`""" def __get__(self): return super().skip_pairing def __set__(self, value: bool): self._set_flag(value, MEM_F_NOPAIRING) property output_all_for_fragments: - """bwa mem -a""" + """:code:`bwa mem -a`""" def __get__(self): return super().output_all_for_fragments def __set__(self, value: bool): self._set_flag(value, MEM_F_ALL) property interleaved_paired_end: - """bwa mem -p""" + """:code:`bwa mem -p`""" def __get__(self): return super().interleaved_paired_end def __set__(self, value: bool): self._set_flag(value, MEM_F_PE | MEM_F_SMARTPE) property short_split_as_secondary: - """bwa mem -M""" + """:code:`bwa mem -M`""" def __get__(self): return (self._options.flag & MEM_F_NO_MULTI) != 0 def __set__(self, value: bool): self._set_flag(value, MEM_F_NO_MULTI) property skip_mate_rescue: - """bwa mem -S""" + """:code:`bwa mem -S`""" def __get__(self): return super().skip_pairing def __set__(self, value: bool): self._set_flag(value, MEM_F_NO_RESCUE) property soft_clip_supplementary: - """bwa mem -Y""" + """:code:`bwa mem -Y`""" def __get__(self): return super().soft_clip_supplementary def __set__(self, value: bool): self._set_flag(value, MEM_F_SOFTCLIP) property with_xr_tag: - """bwa mem -V""" + """:code:`bwa mem -V`""" def __get__(self): return super().with_xr_tag def __set__(self, value: bool): self._set_flag(value, MEM_F_REF_HDR) property query_coord_as_primary: - """bwa mem -5""" + """:code:`bwa mem -5`""" def __get__(self): return super().query_coord_as_primary def __set__(self, value: bool): self._set_flag(value, MEM_F_PRIMARY5 | MEM_F_KEEP_SUPP_MAPQ) # always apply MEM_F_KEEP_SUPP_MAPQ with -5 property keep_mapq_for_supplementary: - """bwa mem -q""" + """:code:`bwa mem -q`""" def __get__(self): return super().keep_mapq_for_supplementary def __set__(self, value: bool): self._set_flag(value, MEM_F_KEEP_SUPP_MAPQ) property with_xb_tag: - """bwa mem -u""" + """:code:`bwa mem -u`""" def __get__(self): return super().with_xb_tag def __set__(self, value: bool): self._set_flag(value, MEM_F_XB) property max_occurrences: - """bwa mem -c """ + """:code:`bwa mem -c `""" def __get__(self): return super().max_occurrences def __set__(self, value: int): @@ -448,7 +448,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.max_occ = 1 property off_diagonal_x_dropoff: - """bwa mem -d """ + """:code:`bwa mem -d `""" def __get__(self): return super().off_diagonal_x_dropoff def __set__(self, value: float): @@ -456,14 +456,14 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.XA_drop_ratio = 1 property ignore_alternate_contigs: - """bwa mem -j""" + """:code:`bwa mem -j`""" def __get__(self): return super()._ignore_alt def __set__(self, value: bool): self._ignore_alt = value property internal_seed_split_factor: - """bwa mem -r """ + """:code:`bwa mem -r `""" def __get__(self): return super().internal_seed_split_factor def __set__(self, value: float): @@ -471,7 +471,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.split_factor = 1 property drop_chain_fraction: - """bwa mem -D """ + """:code:`bwa mem -D `""" def __get__(self): return super().drop_chain_fraction def __set__(self, value: float): @@ -479,7 +479,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.drop_ratio = 1 property max_mate_rescue_rounds: - """bwa mem -m """ + """:code:`bwa mem -m `""" def __get__(self): return super().max_mate_rescue_rounds def __set__(self, value: int): @@ -487,7 +487,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.max_matesw = 1 property min_seeded_bases_in_chain: - """bwa mem -W """ + """:code:`bwa mem -W `""" def __get__(self): return super().min_seeded_bases_in_chain def __set__(self, value: int): @@ -495,7 +495,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.min_chain_weight = 1 property seed_occurrence_in_3rd_round: - """bwa mem -y """ + """:code:`bwa mem -y `""" def __get__(self): return super().seed_occurrence_in_3rd_round def __set__(self, value: int): @@ -503,7 +503,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options0.max_mem_intv = 1 property xa_max_hits: - """bwa mem -h >""" + """:code:`bwa mem -h >`""" def __get__(self): return super().xa_max_hits def __set__(self, value: int | tuple[int, int]): @@ -518,14 +518,14 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options.max_XA_hits_alt = right property xa_drop_ratio: - """bwa mem -y """ + """:code:`bwa mem -y `""" def __get__(self): return self._options.XA_drop_ratio def __set__(self, value: float): self._options.XA_drop_ratio = value property gap_open_penalty: - """bwa mem -O >""" + """:code:`bwa mem -O >`""" def __get__(self): return super().gap_open_penalty def __set__(self, value: int | tuple[int, int]): @@ -540,7 +540,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): self._options.o_ins = insertions property gap_extension_penalty: - """bwa mem -E >""" + """:code:`bwa mem -E >`""" def __get__(self): return super().gap_extension_penalty def __set__(self, value: int | tuple[int, int]): @@ -556,7 +556,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): property clipping_penalty: - """bwa mem -L >""" + """:code:`bwa mem -L >`""" def __get__(self): return super().clipping_penalty def __set__(self, value: int | tuple[int, int]): @@ -572,7 +572,7 @@ cdef class BwaMemOptionsBuilder(BwaMemOptions): cdef class BwaMem: - """The class to align reads with `bwa mem`.""" + """The class to align reads with :code:`bwa mem`.""" cdef BwaIndex _index