Conversation
|
I think I sort of understand what you are doing, but let's chat when you are back |
|
@karinlag Can you have a second look ? |
|
It is almost there. You lose me with the "this"es where you introduce the yaml files :) sort that out, and I'll give it a final readthrough :) |
| conda activate ncbimeta | ||
| ``` | ||
|
|
||
| To use ncbimeta, you will need to use an API (application programming interface) key from NCBI. |
There was a problem hiding this comment.
An API is a way of asking a different computer to send you information. The key is a way for NCBI to associate you with the specific request.
Just concept sorting/clarification.
| per second than you would be able to perform without it. | ||
|
|
||
| To get an API key from NCBI : | ||
| - login (or create an account) |
| - login (or create an account) | ||
| - account > account settings : there you can create an API key you will use - copy it and keep it safe | ||
|
|
||
| We will need to create a configuration file (.yalm) for each metadata download |
| A trick is to create a simple search in NCBI ex: | ||
|  | ||
|
|
||
| This search field will help you build your "metadata download configuration file" (.yalm). |
|
|
||
| Compare it to the [.yalm configuration file](./providencia_metadata.yaml) | ||
|
|
||
| The `.yalm` file allow to define the destination of the download (OUTPUT_DIR), |
| your NCBI identification (EMAIL and API_KEY), the name of the sqlite database it will | ||
| download the metadata to (DATABASE), the tables it will create within the database | ||
| (TABLES) and the columns/fields it will create and download data to for each | ||
| table in the sqlite database (TABLE_COLUMNS, indentation: table name you want, |
|
|
||
| So, you see that you can define your own fields, that were not provided in the other examples found in the [Biosample example](https://github.com/ktmeaton/NCBImeta/tree/master/schema). | ||
|
|
||
| To define those fields you need to access at which hierarchy of the `.xml` file you downloaded as helper. |
There was a problem hiding this comment.
This sentence does not make sense to me.
There was a problem hiding this comment.
And on reread I am completely lost here. I have no idea of how to get to the yaml file I need for the search.
| conda activate NCBImeta | ||
| NCBImeta --config providencia_metadata.yaml --flat | ||
| ``` | ||
|
|
|
|
||
| To use ncbimeta, you will need to use an API (application programming interface) key from NCBI. | ||
| An API key is an authentication code that will serves to tell NCBI that you are the user | ||
| making requests to download metadata via ncbimeta software. Using an NCBI API key |
| run the software, but it is a configuration file that specifies the search/query | ||
| we are asking the software to do: to retrieve the available metadata we are interested in, | ||
| and then the specification of the specific of fields we want to download in a database/table. | ||
|
|
There was a problem hiding this comment.
I suggest you somehwere here show a screenshot of what this file should look like, not only link to it.
|
Are people still working on this? |
|
Yes , still need to do implement what Karin does want me to.modify ...
…On Thu, 19 Sept 2024, 17:58 novica, ***@***.***> wrote:
Are people still working on this?
—
Reply to this email directly, view it on GitHub
<#18 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AK3TRDPFCLFFIENAVNWN3GDZXLYCJAVCNFSM6AAAAAAR5W57ESVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNRRGQYTCOBQG4>
.
You are receiving this because you authored the thread.Message ID:
***@***.***
.com>
|
Please have a fast prettifying/spelling correction and pull this to the github