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.

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

Jump to bottom

Add warning message for under JSON section #94

Merged
merged 2 commits into from
Jan 10, 2024
Merged

Add warning message for under JSON section #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d54f2de
Update data.mdx
sehilyi Jan 10, 2024
a895e41
Update data.mdx
sehilyi Jan 10, 2024
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
11 changes: 9 additions & 2 deletions docs/data.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This format allows for files that follow the [GFF3 specification](https://github
Currently, the GFF3 file must have an accompanying index file. If you do not have an index file for your GFF3 file, you
can create one using [tabix](http://www.htslib.org/doc/tabix.html). Otherwise, you can treat the GFF3 file as if it were a CSV file and use the CSV data specification, but this will not be as performant for large files.

The field names correspond to the names of the columns. For example, the field which corresponds to the "start" column,
The field names correspond to the names of the columns. For example, the field which corresponds to the "start" column
is called "start". The standard GFF fields are as follows: `seq_id`, `source`, `type`, `start`, `end`, `score`, `strand`, `phase`, and `attributes`.

Here is an example GFF3 file line:
Expand Down Expand Up @@ -154,7 +154,14 @@ This format allow files that follow the [VCF specification](https://samtools.git

### JSON (No HiGlass Server)

This format allows users to include data directly in the Gosling's JSON specification.
This format allows users to include data directly in Gosling's JSON specification.

:::caution

For better rendering performance, we recommend using JSON only for small data (~100 rows).
For larger data, consider using CSV or other file formats.

:::

```javascript
{
Expand Down
Loading