search

statonlab / hardwoods_site

Hardwoods Genomics bugs, data loading, and general issues
GNU General Public License v3.0
2 stars 1 forks source link

Help page for how to access HWG data via web services #338

Open mestato opened 6 years ago

mestato commented 6 years ago

Feature description

Unless you are aware HWG is in Tripal and browsing Tripal documentation, you won't know we have web services. We should port the documentation with some customization and examples specific to HWG to our help pages, so that users can find it. Examples might be

<!-What do we want done? Who should do it? Is it urgent or backburner? Please tag/assign issue appropriately. -->

Link to relevant info

almasaeed2010 commented 6 years ago

My understanding of tripal web-services is that they allow you to navigate through the site to find content in a machine readable way. The result of every query is structured as JSON which makes me think that "downloading" data as files (different formats) through web-services is not possible. It is built mainly to query other sites and display the remote data on your application.

The easiest use case I can think of is for other tripal sites to display info about a certain organism on their site by pulling the fields they want from our site. All other use cases that come to mind would require a developer to implement them such as crawling the site for data mining.

bradfordcondon commented 6 years ago

when i last checked, the web services documetnation didnt exist, i think it does now. let me read it and see if there is any point to it for a user's standoint.

mestato commented 6 years ago

I'm not suggesting its useful for all users, I should have specified a "user who knows how to write code or represents another database". Someone may want to use HWG data programmatically but doesn't know anything about Tripal. We don't have to copy the documentation to HWG, just put a link and maybe a few examples specific our database.

On Thu, Aug 2, 2018 at 8:11 AM Bradford Condon notifications@github.com wrote:

when i last checked, the web services documetnation didnt exist, i think it does now. let me read it and see if there is any point to it for a user's standoint.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/statonlab/hardwoods_site/issues/338#issuecomment-409904701, or mute the thread https://github.com/notifications/unsubscribe-auth/AAfA2nfHGl2S63czkfa3XyrSs8Nfr_gXks5uMuxhgaJpZM4Vqj7D .

-- Margaret Staton Assistant Professor Department of Entomology and Plant Pathology 370 PBB, 2505 EJ Chapman Drive Knoxville, TN 37996-4560

864-506-4515 Mobile mstaton1@utk.edu

almasaeed2010 commented 6 years ago

I'll try to get to this tomorrow

almasaeed2010 commented 6 years ago

We have a starter template for this but we need core tripal to develop the docs for remote fields and fix the issue I posted before we can move forward

https://hardwoods.ag.utk.edu/node/2038559

almasaeed2010 commented 6 years ago

Here is the issue for reference: https://github.com/tripal/tripal/issues/565

almasaeed2010 commented 6 years ago

The issue is resolved. We can move forward with this.

almasaeed2010 commented 5 years ago

The tripal documentation still does not have a page on sharing data between sites. Once that's available, we can publish our help pages.