Skip to content

Commit

Permalink
fix(parser.py): update default parameters
Browse files Browse the repository at this point in the history
The default threshold of 0.2 was unusable with fewer than 8 samples.

BREAKING CHANGE: Users should update their configuration files to ensure that they specify 0.2 as the threshold if they wish to continue using the old value.
  • Loading branch information
rbpatt2019 committed Jan 21, 2022
1 parent 35e98d0 commit 878df07
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions lta/parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@
The "0" threshold is specified with option ``-t/--threshold``.
This should be passed as a floating point number between 0 and 1, inclusive.
If it is not provided,
then a default of 0.2 is used.
then a default of 0.3 is used.
The number of bootstrap replicates to use for estimating the p-values
can be specified with ``-b/--boot-reps``.
Generally, higher repetitions increases accuracy,
but there is little apparent improvement past ~10000 repetitions.
A deault of 1000 is used to provide a balance between speed and accuracy.
Many calculations are dependent on knowing where certain metadata is stored.
Expand All @@ -23,7 +22,7 @@
the sample ID (specified with ``--sample-id``),
and the lipidomics mode (specifed with ``--mode``).
If these are not passed,
then they default to "group", "Tissue", "SampleID", and "Mode" respectively.
then they default to "Group", "Tissue", "SampleID", and "Mode" respectively.
We also have to know how many rows of metadata there are.
This is specified with ``--n-rows-metadata``,
Expand All @@ -34,7 +33,7 @@
Without this knowledge,
the concept of fold change is meaningless.
To specify, pass ``--control control``.
Every condition specified in ``group`` will then be divided by ``control``
Every condition specified in ``Group`` will then be divided by ``control``
to calculate the ENFC for all conditions.
Finally,
Expand Down Expand Up @@ -100,7 +99,7 @@
"--threshold",
type=float,
choices=FloatRange(0, 1), # type: ignore
default=0.2,
default=0.3,
help="The '0' threshold",
)

Expand All @@ -123,7 +122,7 @@
lta_parser.add_argument(
"--group",
type=str,
default="group",
default="Group",
help="Metadata label for experimental conditions",
)

Expand All @@ -137,7 +136,7 @@
lta_parser.add_argument(
"--tissue",
type=str,
default="Tissue",
default="Compartment",
help="Metadata label for sample tissue",
)

Expand Down

0 comments on commit 878df07

Please sign in to comment.