search

NCHlab / RTPEA

Retroelement Protein Expression Atlas
http://www.rtpea.com
1 stars 0 forks source link

API page 2.0 #46

Closed Nazrath10R closed 5 years ago

Nazrath10R commented 6 years ago

Ok, so I thought about expanding the API page

Firstly, let's change the name of the tab to 'download'. That'll go along with the other tab names: browse, visualise, download

So this is my idea. Let's split the page into 3 sections:

  1. a user-friendly download page with basically just a few buttons
    • a button to download the whole table data (https://api.rtpea.com/table basically)
    • a button to download the protein sequences; call the button 'download all L1 prot sequences'
    • a button (placeholder for now) to download the protvista database

should be really easy and little work, but will look like a new and useful feature

  1. programmatic access so the API section here add the examples from your thesis as code text boxes onto the page for the different languages

  2. download proteomic experimental parameters Create this placeholder place to download my mined parameters. Let's discuss with conrad this week and see what he says, but basically if we put all the parameter files onto the server, we can use a simple dropdown box with PXDs to download the experimental parameters

NCHlab commented 6 years ago

Page:

https://rtpea.com/download

NCHlab commented 6 years ago

image

Nazrath10R commented 6 years ago

Good progress! I like that you got the code boxes done.

Regarding the code itself. I can see why you are showing a practical example of a list of id's and running a loop, but I think an API is better sold showing how simple it is.

It's just a single line needed to download the data, so let's show exactly that by displaying how easy it is to use.

An API user will know how to write a for loop to go through a list, so it's no big deal for him. But the target audience being biologists, showing to them that all they have to do is open the CL and copy that one line makes it more attractive and wanting to try out. Or at least easier to understand and think about giving it a chance.

I think we should do the same for the demo video as well. Show an example of writing wget {code} first and then your little script to run for a series as a more practical example second.

I suspect you put the exp parameters in the same table just for now. Since it is a completely different biological question, it should be in its own section eventually