waldronlab / BugSigDB

A microbial signatures database
https://bugsigdb.org
7 stars 6 forks source link

Add a study/experiment/signature via API #134

Closed lwaldron closed 1 year ago

lwaldron commented 2 years ago

Qiita (https://qiita.ucsd.edu/) is a popular open-source microbial study management platform that researchers use to analyze their metagenomic data. They are developing a differential abundance workflow and have expressed interest in having it post the output of a completed workflow programmatically to bugsigdb.org (this would be pre-publication). Such a workflow could help a lot with having researchers enter their own data into bugsigdb rather than only us doing it after publication.

Is this feasible through the default API (https://bugsigdb.org/Special:ApiSandbox) or what would be involved in supporting this?

lgeistlinger commented 1 year ago

This actually sounds pretty cool! Can this be implemented @tosfos?

tosfos commented 1 year ago

I believe so. We'll check what's involved.

tosfos commented 1 year ago

We're going to send some instructions. It should be fairly simple.

tosfos commented 1 year ago

The instructions are ready. Where would be the best place for them? We can post them here, save them on a Help page in the wiki, or prepare a PDF.

lgeistlinger commented 1 year ago

I think a help page in the wiki will be best @lwaldron?

lwaldron commented 1 year ago

Yes I agree, a help page on the wiki, then we'll link to it from the ? page.

tosfos commented 1 year ago

The Help page was created here Please let me know if you have any questions.