Size: 23170
Comment:
|
Size: 23237
Comment:
|
Deletions are marked like this. | Additions are marked like this. |
Line 139: | Line 139: |
* [[https://interbull.org/ib/pse_file_formats|PSE File Formats]] |
GenoEx- PSE – User's Manual
This document describes the procedures for the upload and download of the data for the GenoEx-PSE service.
It describes in details required file formats, login process and usage of the service itself both for data upload and download.
Please note that GenoEx service is under regular improvement and thus new functionalities may be introduced. It is therefore important to always use the latest version of this manual.
1. File formats
The SNP genotype data and the related information submitted (uploaded) to GenoEx-PSE is categorized in two groups:
A) Information related to a group of animals with a SNP genotype to upload ('meta.csv' file)
B) Information related to the actual SNP genotypes for the animals in 1) ('snps.csv' file)
At each upload from a Service User, both files must be zipped together and submitted at the same time. Data submitted in one file will not be processed until both files are available.
Data extracted from the GenoEx-PSE database generally follow the same format than the data uploaded. They however, contain additional column with unique Upload ID allowing to match meta.csv and snps.csv files coming from one upload event. Therefore, Upload ID allows distingushing multiple records of one individual coming from different sources and/or genotyping events.
1A - meta.csv file - Information Related to a Group of Animals
This file is required to be a variable length, comma delimited file in .csv format including a single record for each animal for which a SNP genotype details is being reported in the snps.csv file. For example, if the snps.csv file (File 704-AB or 704-TOP) includes SNP genotype results for 100 animals, the meta.csv file will have 100 records, one per animal.
Field Name |
Example |
Description |
Record Type |
702 |
Numeric |
Service User |
INRA |
Alphanumeric |
Source Country of Animals |
FRA |
Code of 3 CAPITAL letters according to Country List |
Animal ID - Breed Code |
BSW |
Code of 3 CAPITAL letters according to Breed List |
Animal ID - Nation Code |
AUS |
Code of 3 CAPITAL letters according to Country List |
Animal ID - Sex Code |
M |
Alpha (M or F) |
Animal ID - Registration |
A1234567890 |
Alphanumeric, maximum 18 characters |
Genotyping Laboratory Identification |
Genotyping Laboratory |
Alphanumeric according to the Laboratory List OR added as new* |
Sample ID |
R1234567890 |
Alphanumeric, sample numbers used in the genotyping laboratory |
Scan Date |
yyyymmdd |
Numeric, the date when the laboratory concluded the analysis. |
Platform |
Illumina |
Alphanumeric, SNP Chip Platform according to the Platform List* |
No. SNPs in Genotype |
54001 |
Total number of SNPs* |
Genotype Call Rate |
99.98 |
Percent call rate of the animal's full genotype used to create the SNP record for GenoEx-PSE, two decimals. |
! download only: |
||
upload ID |
1fdb3a18-4a0d-41ee-8530-dac3880d00cf |
Unique ID allowing to match multiple data files of the same individual by upload event. |
Table 1A. Format of the meta.csv file used for uploading general information for the group of animals for which SNP genotypes are submitted in the associated snps.csv file (format below).
* new laboratories, platforms and arrays need to be communicated to Interbull by e-mail prior to data submission.
1B - Information Related to the SNP Genotypes of Animals – snps.csv file
snps.csv files contains the actual genotype data for the animals listed in the corresponding meta.csv file. The Service User may select to upload and/or download SNP genotype data in either the "AB" or "TOP" allele designations, which determines the content of the first field, namely Record Type, in the following file format (i.e.: File 704-AB versus File 704-TOP, respectively). This file will be exchanged as a variable length, comma delimited file in .csv format and include a single record for each SNP included for each animal. For example, if meta.csv file includes 100 animals and each SNP genotype include the 200 SNPs recommended by ISAG for Parentage Verification then this second file will include a maximum of 20,000 records (100 animals x 200 SNPs each). In the event that any SNP was not "called" and the result is missing, then that SNP for that animal should not be included in the GenoEx-PSE genotype exchange file. For this reason, even if the meta.csv file includes 100 animals, this second file may not necessarily have a total of 20,000 records.
Field Name |
Example |
Description |
Record Type |
704-AB (or 704-TOP) |
Alphanumeric |
Animal ID - Breed Code |
BSW |
Code of 3 CAPITAL letters according to Breed List |
Animal ID - Nation Code |
AUS |
Code of 3 CAPITAL letters according to Country List |
Animal ID - Sex Code |
M |
Alpha (M or F) |
Animal ID - Registration |
A1234567890 |
Alphanumeric, maximum 18 characters |
SNP Name |
ARS-BFGL-BAC-19454 |
Alphanumeric (CAPITAL letters only) |
Allele 1 |
A/B or A/C/G/T |
Alphabetic (CAPITAL letters only) |
Allele 2 |
A/B or A/C/G/T |
Alphabetic (CAPITAL letters only) |
! download only: |
||
upload ID |
1fdb3a18-4a0d-41ee-8530-dac3880d00cf |
Unique ID allowing to match multiple data files of the same individual by upload event. |
Table 1B. Format to be used for uploading the specific SNP genotypes to the GenoEx-PSE database.
! Please note: since the input files are comma delimited, if any of your fields require comma sign, you ought to add the escape character ‘\’ before comma e.g. ‘Laboratory\, Branch’.
If you wish to upload more than one genotype for a given animal, you will have to do it in a separate set of files. This is because the data base does not accept any duplicates, in order to allow distinguishing between various genotyping events.
The information downloaded from GenoEX-PSE follows the same formats both for the meta.csv and the snps.csv files with the addition of Upload ID (see above).
2. Login
After you have signed the User’s Agreement and joined the service, you will receive login details from Interbull Center for the users you have requested access for. From this moment you are entitled to use the GenoEx-PSE service via genoex.org.
The login tab can be found on the top right corner of the front page. If you have lost or forgotten your password, a new password can be requested from the Lost Password page, which can be accessed both under the login tab and from the login page. Once you log in you can change your password by pressing the Change password under your username tab in the top right corner. We highly recommend that you change the password from the one provided to you, at the very first login.
Under the About tab, you will find links to all documentation relevant for the GenoEx-services.
Under the Contact tab you will find information needed to contact Interbull Center should you have any questions, comments or concerns regarding the platform or the service.
The History tab directs you to the history page, where you find a table showing all the uploads or downloads done by any user of your organization. The history table as well as downloads and uploads, found under the PSE-tab, will be described in the following sections.
3. Data Upload
To access the Upload page, go to the PSE tab and click Upload. The data to be uploaded must be presented in a .zip-file as described in section 1 of the Users Manual. Details of the file format you can find HERE. Click the Browse button, find and select the file to be uploaded, and then click UPLOAD.
After pressing the UPLOAD button, you will be redirected to a status-page showing the job-id, job type, current status and the date and time, as shown in the pictures below.
An uploading process can have four different statuses: Initiated, Processing, Finished or Failed. At the initial re-direction from the upload page, the current status will be shown as Initiated. The duration of the upload process depends on the size of your file. To follow the progress of your upload, you can either refresh the status page as shown in the three following pictures, or go to the History table. When the Processing is complete, and the upload is either successful or failed, you will receive a notificiation via e-mail to the e-mail address connected to your GenoEx user account.
Failed upload
In the case where the upload is unsuccessful, the job status will be displayed as Failed. The number of errors and the cause of the failed upload will be shown. In the case presented in the image below, the upload failed as the animal-ID used in the snps.csv-file did not correspond to the animal-ID used in the meta.csv-file.
4. Data extraction
To access the download page, go to the PSE-tab and click Download.
In the download page, query the desired data by sex, breed and country. A selection must be done in all three fields for the extraction to be initiated. In order to select more than one criteria use CTRL+click.
The data can be extracted either in TOP-format or in AB-format, independently of the format that it was submitted in.
In cases where animals is represented with more than one genotype, the Best only will give you the genotype with the highest call rate. By selecting All you will be provided with all the genotypes your organization have access to.
Specific time periods of when data has been uploaded can be select, to for example only download data that has become available since your latest download. The dates provided by default gives you all data uploaded to the database that your organization has access to.
When all the extraction criteria are selected, click CREATE EXTRACTION.
After clicking CREATE EXTRACTION, you will be redirected to a status-page showing the job-id, job type, current status and the date and time, as shown in the pictures below. A downloading process can have two different statuses: Processing or Finished. At the initial re-direction from the upload page, the current status will be shown as Processing. The duration of the download process depends on the amount of data that is extracted. To follow the progress of your download, you can either refresh the status page as shown in the two following pictures, or go to the History table. When the Processing is complete, and the download is Finished, you will receive a notificiation via e-mail to the e-mail address connected to your GenoEx user account.
When the extraction is completed, you can fetch the extracted file by clicking on Download extracted file on the jobs status page. The downloaded file can be fetched either directly, or at a later time and date. The data will be presented in a zipped folder containing the files snps.csv and meta.csv, following the file format as described in section 1. Note that the download files has an extra column compared to the uploaded files, as they contain a unique identifier in order to separate several genotypes for the same animal.
5 HISTORY
The progress of both uploads and downloads can also be followed in the history table.
The table is by default sorted by date, with the most recent job shown first, but all headers can be pressed to change the sorting as you choose. The search field can be used to easier find specific jobs you may search for.
By clicking on the job-ID of the job of your interest, you will be re-directed to the status-page for that upload or download.