Skip to content

Commit

Permalink
UPD more toods/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eboileau committed May 24, 2024
1 parent b010778 commit 806a342
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
6 changes: 5 additions & 1 deletion TODO.org
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ Draft or long-running issues, WIP, triage, and additional references or context
- [ ] ~pre-commit run --all-files~ under server (.pre-commit-config.yaml) runs for all files incl. client.
- [X] Add *CrossMap* to requirements.

** TODO STYLE [1/19]
** TODO STYLE [1/20]

- [ ] DEADLINE: <2024-09-30 Mon> To harmonize style across views, components, and presets (colours, behaviour, dark mode, /etc./).

- [ ] CascadeSelect :: "No available options" is not defined, /cf./ TreeSelect or Dropdown. Styling is different.
- [ ] In ~ProjectMetadata,vue~, some placeholders are grey, others are black/darker (resp. ligher in dark mode).
- [ ] Dark mode (specific issues)
- [ ] Logos are displayed in greyscale in dark mode, as invert also inverts the colors. Otherwise, we may have to use 2 logos,
or create SVGs.
Expand Down Expand Up @@ -114,6 +115,9 @@ Draft or long-running issues, WIP, triage, and additional references or context
then (3) format filename (this is the current solution).
- [X] browse :: Additional information for the ~Dialog~ or for the export? /e.g./ ~sequencing_platform~, ~basecalling~, ~bioinformatics_workflow~,
~experiment~, and/or ~ProjectContact~ (~Project~ or eventually ~Dataset~ contact).
- [ ] browse :: Maybe the project ~added_date~ is not needed?
- [ ] project :: When adding more than 1 metadata sheet, assembly is reset, also resetting the model. This is not critical,
since we ask user to write the assembly as input, but would be nice to sort.

- [X] router :: All routes to ~/~ with backward/forward navigation? This does not allow either to open a link in a new tab. Also how would
that work with route guards, secure routes, /etc./? Finally, with route params (/e.g./ ~Browse~, where EUFID is directly added to the index),
Expand Down
27 changes: 27 additions & 0 deletions server/docs/source/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,33 @@ These steps, except user-project association, can be done all at once with
flask batch DIRECTORY [TEMPLATES]
This requires a non-standard project template (json) with additional keys: ``file_name`` and ``data_title`` for each ``metadata`` value, *e.g.*

.. code-block:: json
{
...
"metadata": {
"rna": "mRNA",
"modomics_id": "2000000006A",
"tech": "m6A-SAC-seq",
"method_id": "e00d694d",
"organism": {"taxa_id": 9606, "cto": "HeLa", "assembly": "GRCh38"},
"file_name": "filename.bedrmod",
"data_title": "HeLa WT treatment A replicate 1",
"extra": [
"Homo sapiens",
"HeLa",
"wild type",
"treatment A",
"polyA RNA"
]
}
}
Additional keys are ignored and can be used for documentation. All templates and bedRMod files must be under the same directory.
Values in the template are used *as is* to query and update the database.

Permissions can be updated with

.. code-block:: bash
Expand Down

0 comments on commit 806a342

Please sign in to comment.