Skip to content

Commit

Permalink
update skip-quantile-normalization documentation to improve clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
avrohomgottlieb committed Aug 14, 2024
1 parent d4620ca commit b40881a
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ You can also pass in other optional command options to alter the Dataset itself

* **transformation** - Can be used to change the transformation of the Dataset. The default is "NONE", and the other available choices are "MINMAX" and "STANDARD". For more information on Dataset transformation check out `Gene transformations`_.

* **skip-quantile-normalization** - Can be used to choose whether or not quantile normalization is skipped for RNA-seq Samples. For more information check out `Quantile normalization`_.
* **skip-quantile-normalization** - Can be used to disable quantile normalization for RNA-seq Samples, which is performed by default. For more information check out `Quantile normalization`_.

* **extract** - Can be used to choose whether the downloaded zip file should be automatically extracted. It will automatically extract to the same location that you passed in as :code:`path`. So if :code:`path` is a zip file: :code:`./path/to/dataset.zip` it will be extracted to the dir :code:`./path/to/dataset/`, if :code:`path` is a dir: :code:`./path/to/dir/` it will be extracted to :code:`./path/to/dir/[generated-file-name]/`. By default, :code:`extract` is False.

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ You can also pass in other optional parameters to alter the Dataset itself and t

* **transformation** `(str)` - Can be used to change the transformation of the Dataset. The default is "NONE", and the other available choices are "MINMAX" and "STANDARD". For more information on Dataset transformation check out `Gene transformations`_.

* **skip_quantile_normalization** `(bool)` - Can be used to choose whether or not quantile normalization is skipped for RNA-seq Samples. For more information check out `Quantile normalization`_.
* **skip_quantile_normalization** `(bool)` - Can be used to disable quantile normalization for RNA-seq Samples, which is performed by default. For more information check out `Quantile normalization`_.

* **extract** `(bool)` - Can be used to choose whether the downloaded zip file should be automatically extracted. It will automatically extract to the same location that you passed in as :code:`path`. So if :code:`path` is a zip file: :code:`./path/to/dataset.zip` it will be extracted to the dir :code:`./path/to/dataset/`, if :code:`path` is a dir: :code:`./path/to/dir/` it will be extracted to :code:`./path/to/dir/[generated-file-name]/`. By default, :code:`extract` is False.

Expand Down
3 changes: 2 additions & 1 deletion pyrefinebio/high_level_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ def download_dataset(
transformation (str): the transformation for the dataset - `NONE`, `MINMAX`, or `STANDARD`
skip_quantile_normalization (bool): control whether or not the dataset should skip quantile
normalization for RNA-seq Samples
normalization for RNA-seq Samples. Quantile normalization
is performed by default.
quant_sf_only (bool): include only quant.sf files in the generated dataset.
Expand Down
2 changes: 1 addition & 1 deletion pyrefinebio/script.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def describe(entity=None):
"--skip-quantile-normalization",
default=False,
type=click.BOOL,
help="Control whether the Dataset should skip quantile normalization for RNA-seq Samples",
help="Control whether the Dataset should skip quantile normalization for RNA-seq Samples. Quantile normalization is performed by default.",
)
@click.option(
"--timeout",
Expand Down

0 comments on commit b40881a

Please sign in to comment.