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

Data format documentation #82

Open
almasaeed2010 opened this issue Apr 3, 2018 · 7 comments
Open

Data format documentation #82

almasaeed2010 opened this issue Apr 3, 2018 · 7 comments
Assignees
Milestone

Comments

@almasaeed2010
Copy link

almasaeed2010 commented Apr 3, 2018

Hello all,

We recently started using CMap-js (great job btw!), and were wondering about what formats the software accepts. Any information on how to generate data files is also very much appreciated.

We currently have a file in FPC format that doesn't seem to work with the current implementation: https://hardwoodgenomics.org/sites/default/files/physical_map/Chinese_Chestnut_FPC_v4.fpc

Thanks!

@awilkey
Copy link
Contributor

awilkey commented Apr 3, 2018

Right now the only format fully supported is the old cmap tabular format, which was a choice mainly due to availability and ease of support. After the current round of bug fixes and UI tweaks (with the goal to be able to call it moved out of alpha and into beta) I do have plans on revisiting the data loader and expanding file format support.

Now is a great time to be requesting additional file formats for support.

@bradfordcondon
Copy link

bradfordcondon commented Apr 17, 2018

My 2 cents: FPC is a deprecated format and not worth supporting.

We would want support for a postgresql database using Chado formatted maps, which would be stored according to the map module presumably. We could code the database interface on our end to interact with Chado to supply cmap-js with, for example, JSON formatted data.

So to clarify, we would want to supply cmap-js with a URL query, which we would code in Tripal to return a JSON object with data cmap-js can read.

Edit: I guess alternatively we just return a cmap file...

@adf-ncgr
Copy link
Member

agreed, I think it would be good for us (including interested adopters) to spend some time specifying a JSON schema for service provider implementations (chado-backed or otherwise) to target. That said, for use cases involving users reading local data for comparison with maps published on sites we will still want to have a few flatfile options based on software for QTL/GWAS mapping (or similar) that is currently being used by the community. But I agree that FPC is probably not being widely used these days, and could be converted into a cmap format without too much effort (IIRC, the old cmap used to be able to handle FPC maps though maybe there was a conversion step involved).

@adf-ncgr
Copy link
Member

@sammyjava you will probably want to participate in the discussion of this from the intermine angle too (which must have been in the back of my mind when I wrote: "chado-backed or otherwise")

@sammyjava
Copy link

I prefer JSON simply because that's what other InterMine displayers use. But otherwise I'm not too particular, I can presumably hack the appropriate file format.

@jd-campbell
Copy link
Contributor

FYI @awilkey It came up in the May 24th LegumeFed meeting (short discussion about cmap-js) about the request for a spec for the allowed json format(s).

@nathanweeks nathanweeks added this to the 1.0 milestone Mar 28, 2023
@nathanweeks nathanweeks linked a pull request Mar 28, 2023 that will close this issue
@nathanweeks nathanweeks removed a link to a pull request Apr 5, 2023
@nathanweeks
Copy link
Contributor

If there's no other widely-used JSON map data format, a JSON representation of the cmap tab-delimited file format may at least be straightforward to support in cmap-js.

@nathanweeks nathanweeks modified the milestones: 1.0, 1.2 Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants