Skip to content

DOC: Update documentation in help text #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ElDeveloper wants to merge 1 commit into
base: master
Choose a base branch
from
Open

DOC: Update documentation in help text #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions gemelli/_defaults.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
DESC_ITERATIONS = ("The number of iterations to optimize the solution"
" (suggested to be below 100; beware of overfitting)"
" [minimum 1]")
DESC_INIT = ("The number of initialization vectors. Larger values will"
DESC_INIT = ("The number of initialization vectors. Larger values will "
"give more accurate factorization but will be more "
"computationally expensive [minimum 1]")
DESC_ITERATIONSALS = ("Max number of Alternating Least Square (ALS)"
Expand Down Expand Up @@ -58,11 +58,12 @@
" across which samples are paired."
" At least one is required but up to four are allowed"
" by other state inputs.")
QORD = ("A trajectory is an ordination that can be visualized"
QORD = ("A '%s trajectory ordination' that can be visualized "
"over time or another context.")
QDIST = ("A sample-sample distance matrix generated from "
" the euclidean distance of the subject-state "
"ordinations and itself.")
" the Euclidean distance of the subject-state "
"ordinations and itself. Similar to the distance matrix produced by"
" RPCA except it also accounts for the subject and state context.")
QLOAD = ("Compositional biplot of subjects as points and features as arrows."
" Where the variation between subject groupings is explained by the"
" log-ratio between opposing arrows. "
Expand Down
4 changes: 2 additions & 2 deletions gemelli/q2/plugin_setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@
output_descriptions={'subject_biplot': QLOAD,
'state_biplot': QSOAD,
'distance_matrix': QDIST,
'state_subject_ordination': QORD,
'state_feature_ordination': QORD},
'state_subject_ordination': QORD % 'subject',
'state_feature_ordination': QORD % 'feature'},
name='Compositional Tensor Factorization (CTF) with mode 3 tensor. This '
'means subjects have repeated measures across only one '
'axis (e.g. time or space).',
Expand Down