-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): minor edits to docs (#69)
- platform -> OS - workspace -> folder - Normalize capitalization of data hub, compute hub, workstation, Python - Lint: removed trailing spaces and consecutive blank lines in docs
- Loading branch information
Showing
17 changed files
with
107 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# Compute Hub | ||
# Compute hub | ||
|
||
The Deep Origin Compute Hub allows you create and use powerful workstations that come with pre-installed software packages. Deep Origin was built to help computational scientists get clean data from their labs and perform advanced analyses and simulations. | ||
The Deep Origin compute hub allows you create and use powerful workstations with pre-installed software packages. Deep Origin was built to help computational scientists get clean data from their labs and perform advanced analyses and simulations. | ||
|
||
Every Deep Origin Workstation comes pre-installed and pre-configured with this python client and CLI. | ||
Each Deep Origin workstation comes pre-installed and pre-configured with this Python client and CLI. | ||
|
||
Read more about the Compute Hub [here :octicons-link-external-16:](https://docs.deeporigin.io/docs/os/compute-hub). | ||
Learn more about the compute hub [here :octicons-link-external-16:](https://docs.deeporigin.io/docs/os/compute-hub). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,16 @@ | ||
# Data Hub | ||
# Data hub | ||
|
||
The Deep Origin data hub provides R&D teams a foundation for collaboratively capturing data, extracting insights, and making decisions: | ||
|
||
- Databases for capturing rows of data, metadata, and procedures. | ||
- Customizable columns for capturing structured information such as the age and genotype of a sample. | ||
- Notebooks such as for common protocols and recording experiments. | ||
- File columns and notebook attachments for capturing files such as the results of experiments. | ||
- Reference columns and notebook mentions for capturing relationships, such as the chemical, RNA, antibody, or cell line that an assay characterized. | ||
- Folders for hierarchically organizing data, such as by project, team, or experimental modality. | ||
- Column and file viewers such as for visualizing the sequence of a plasmid or the structure of a chemical or protein. | ||
- Chart studio for interactively analyzing columnar data. | ||
- AI assistant for interactively analyze and visualize data. | ||
- Advanced computational analysis with workflows and workstations. | ||
- Process flows and automations for streamlining data processing, decision-making, and project management. | ||
- **Databases** for capturing rows of data, metadata, and procedures. | ||
- Customizable columns for capturing structured information such as the age and genotype of a sample. | ||
- **Notebooks** such as for common protocols and recording experiments. | ||
- File columns and notebook attachments for capturing files such as the results of experiments. | ||
- Reference columns and notebook mentions for capturing relationships, such as the chemical, RNA, antibody, or cell line that an assay characterized. | ||
- **Folders** for hierarchically organizing data, such as by project, team, or experimental modality. | ||
- **Column and file viewers** such as for visualizing the sequence of a plasmid or the structure of a chemical or protein. | ||
- **Chart studio** for interactively analyzing columnar data. | ||
- **AI assistant** for interactively analyze and visualize data. | ||
- **Process flows and automations** for streamlining data processing, decision-making, and project management. | ||
|
||
|
||
Read more about the Data Hub [here :octicons-link-external-16:](https://docs.deeporigin.io/docs/os/data-hub). | ||
Learn more about the data hub [here :octicons-link-external-16:](https://docs.deeporigin.io/docs/os/data-hub). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,74 +1,57 @@ | ||
This document describes how to delete | ||
This document describes how to delete objects in the Deep Origin data hub: | ||
|
||
- database rows | ||
- database columns | ||
- databases and | ||
- folders | ||
|
||
in the Deep Origin Data Hub. | ||
- Database rows | ||
- Database columns | ||
- Databases | ||
- Folders (workspaces) | ||
|
||
!!! danger "Exercise caution" | ||
- Deleting a workspace deletes all databases inside it. | ||
- Deleting a column destroys all data in that column, including all files assigned to cells in that column. | ||
- Deleting a database deletes all rows inside it. | ||
- Deleting a folder deletes all of the databases in the folder. | ||
- Deleting a column destroys all of the data in that column, including all of the files assigned to the cells in that column. | ||
- Deleting a database deletes all of the rows in the database. | ||
|
||
All resources will be deleted without asking for confirmation. | ||
|
||
## Delete database rows, databases, and folders | ||
|
||
=== "CLI" | ||
To delete multiple rows, databases and folders, run: | ||
|
||
Multiple rows, databases and folders can be deleted using: | ||
=== "CLI" | ||
|
||
```bash | ||
deeporigin data delete --ids <ids> | ||
``` | ||
|
||
|
||
|
||
=== "Python" | ||
|
||
|
||
|
||
```py | ||
from deeporigin.data_hub import api | ||
api.delete_rows(row_ids=["row-1","database-1","workspace-1"]) | ||
api.delete_rows(row_ids=["row-1","database-1","folder-1"]) | ||
``` | ||
|
||
!!! Info "Rows?" | ||
Rows, workspaces and databases can all be deleted using the `delete_rows` method. | ||
|
||
|
||
Rows, folders and databases can all be deleted using the `delete_rows` method. | ||
|
||
## Delete database columns | ||
|
||
|
||
## Delete database columns | ||
|
||
Columns in databases can be deleted using: | ||
To delete columns in databases, run: | ||
|
||
=== "CLI" | ||
|
||
|
||
|
||
```bash | ||
deeporigin data delete --ids <ids> --columns | ||
``` | ||
|
||
!!! warning "Column IDs" | ||
Currently, columns can only be deleted using Column IDs, which are not the same as column names. To view the column IDs of a database, use | ||
Currently, columns can only be deleted using their IDs, which are distinct from their names. To view the IDs of the columns of a database, run: | ||
|
||
```bash | ||
deeporigin data describe <database-id> | ||
``` | ||
|
||
|
||
|
||
=== "Python" | ||
|
||
|
||
|
||
```py | ||
from deeporigin.data_hub import api | ||
api.delete_database_column(column_id="col-id") | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.