Skip to content
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.

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

Updating README #71

Merged
merged 25 commits into from
Jun 21, 2022
Merged
Changes from 2 commits
Commits
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
18 changes: 14 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,12 @@ object IDs in the ``OMERO.table``.

The ``CSV`` file must be provided as local file with ``--file path/to/file.csv``.

If you wish to ensure that ``number`` columns are created for numerical data, this will
allow you to make numerical queries on the table.


Automatic Column Types
^^^^^^^^^

**The default behaviour of the script is to automatically detect the column types and specific object types from an input ``CSV`` using the list below.**
muhanadz marked this conversation as resolved.
Show resolved Hide resolved
Column Types are:

- ``d``: ``DoubleColumn``, for floating point numbers
Expand All @@ -80,8 +84,14 @@ Column Types are:
- ``b``: ``BoolColumn``, for true/false
- ``plate``, ``well``, ``image``, ``dataset``, ``roi`` to specify objects

These can be specified in the first row of a ``CSV`` with a ``# header`` tag (see examples below).
The ``# header`` row is optional. Default column type is ``String``.


Manual Column Types
^^^^^^^^^

However, it is possible to override the default behaviour, ignoring the automatic header detection, and manually assign the header to define the column type if a ``CSV`` with with a ``# header`` tag is passed (see examples below).
muhanadz marked this conversation as resolved.
Show resolved Hide resolved

Automatic header detection can also be ignored if using the ``--manual_headers`` flag. If the ``# header`` is not present and this flag is used, column types will default to ``String``
muhanadz marked this conversation as resolved.
Show resolved Hide resolved

NB: Column names should not contain spaces if you want to be able to query
by these columns.
Expand Down