Skip to content

Commit

Permalink
sphinx fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
ens-ftricomi committed May 28, 2024
1 parent a90fd9f commit 160735c
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions src/python/ensembl/tools/anno/transcriptomic_annotation/star.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ def run_star( # pylint:disable=too-many-branches
) -> None:
"""
Run STAR alignment on list of short read data.
:param genome_file: Genome file path.
:type genome_file: Path
:param output_dir: Working directory path.
Expand All @@ -81,15 +82,11 @@ def run_star( # pylint:disable=too-many-branches
:type subsample_read_limit:int, default 100000000,
:param subsample_percentage: Maximun percentage of reads to subsample.
:type subsample_percentage: int, default 0.25,
:param sampling_via_read_limit: If True will subsample an input dataset of \
fastq files using --subsample_read_limit value.
:param sampling_via_read_limit: subsample fastq files using --subsample_read_limit.
:type sampling_via_read_limit : boolean, False,
:param sampling_via_percentage: If True will subsample an input dataset of \
fastq files using --subsample_percentage value.
:param sampling_via_percentage: subsample fastq files using --subsample_percentage.
:type sampling_via_percentage : boolean, False,
:param sampling_via_read_limit_percentage: If True will subsample an input dataset \
of fastq files using --subsample_read_limit and --subsample_percentage value; \
the lowest number of reads is taken.
:param sampling_via_read_limit_percentage: use max read limit and percentage value.
:type sampling_via_read_limit_percentage : boolean, False,
:param num_threads: Number of available threads.
:type num_threads: int, default 1
Expand Down

0 comments on commit 160735c

Please sign in to comment.