How to define the name of a schema?

KarrLab / obj_tables

Tools for creating and reusing high-quality spreadsheets

https://objtables.org

MIT License

8 stars 2 forks source link

How to define the name of a schema? #155

Closed liebermeister closed 4 years ago

liebermeister commented 4 years ago

Hi Jonathan,

on the documentation page, in "Tabular format for datasets" I find

"schema: Use this key to annotate the name of the schema of the table. If this key is set, ObjTables will check that its value matches the name of the schema used to interpret the table."

It's not clear to me how the name of the schema is defined in the schema file itself. Is there a metadata item "name='..'"? Could you maybe clarify this in the documentation?

Thank you!

Best, Wolf

jonrkarr commented 4 years ago

Yes, the name of the schema can be defined two ways

Tabular-formatted schemas: the name can be define in the metadata for the schema
```
!!ObjTables ... name='...' ...
```
Python schemas: the name is the name of the Python module (equivalent to the filename)

I'll clarify this in the documentation

jonrkarr commented 4 years ago

I added documentation