Differences between revisions 33 and 34
Revision 33 as of 2024-02-21 11:14:26
Size: 20580
Comment:
Revision 34 as of 2024-03-01 11:39:43
Size: 23170
Comment:
Deletions are marked like this. Additions are marked like this.
Line 74: Line 74:
After contacting the Interbull Center and signing the User's Agreement, you receive the details for your login. From this moment you are entitled to use the !GenoEx-PSE service, via the main page: genoex.org 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 [[https://genoex.org/|genoex.org]].
Line 76: Line 76:
Login tab can be found on the top right corner of the page. Shall you forget your password, you can send password recovery request. 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.
Line 78: Line 78:
{{attachment:login.png}} Under the '''About''' tab, you will find links to all documentation relevant for the !GenoEx-services.
Line 80: Line 80:
After login you will see more options: 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.
Line 82: Line 82:
{{attachment:loggedInMenu.png|loggenInMenu.png}} 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.
Line 84: Line 84:
Once you log in you can see your account details or change your password if you wish so by choosing respectively '''''Profile''''' and '''''Change Password''''' options under your user name.

{{attachment:user_profile2.png}}
{{attachment:1_afterlogin.JPG}}
Line 89: Line 87:
In order to upload the data you shall click on the '''''Upload''''' menu on the top of the page: 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 [[https://interbull.org/ib/pse_file_formats|HERE]]. Click the '''Browse '''button, find and select the file to be uploaded, and then click UPLOAD.
Line 91: Line 89:
{{attachment:top_upload13.png}} {{attachment:2_upload.JPG||height="338",width="901"}}
Line 93: Line 91:
To upload the data by uploading a .zip file as described in point 1. 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.
Line 95: Line 93:
Shall you have any doubts on how the data should be formatted, or what values are allowed in a given field, click on the '''''About Upload Formats '''''menu (in the blue area on the lower part of the page) for more information. To initiate the upload browse for the zipped files in your computer. 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.
Line 97: Line 95:
{{attachment:helplist2.png}} {{attachment:3a_statusUpload_initating.JPG||height="297",width="901"}}
Line 99: Line 97:
Once you initialized the upload, you will be redirected to the upload status page, where you can track the upload progress. {{attachment:3b_statusUpload_processing.JPG||height="285",width="901"}}
Line 101: Line 99:
{{attachment:status3.png}} {{attachment:3c_statusUpload_finished.JPG||height="301",width="901"}}
Line 103: Line 101:
Once the upload is finished you will be able to confirm the success of the data submission or see the reason of possible failure. The status page contains the information about the file name (used by you) and job ID (assigned by system) === 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.
Line 105: Line 104:
{{attachment:status_success2.png}}

The duration of the upload process depends on the size of your file and your internet connection. If there was an error or missing information in your data, the system will notify you about it with the detailed error message.

{{attachment:Ufailed_platform1.png}}

Above you can see the example of upload failure because of invalid platform/array in the data.

The upload status page can also be reached by '''''History''''' tab on the top menu.

{{attachment:top_history.png}}

On the '''''History''''' page you can see all upload and download actions from your organization sorted by date and named by the job status ID. Clicking on the selected job will open the action’s details, like in the examples above.
{{attachment:3d_statusUpload_failed.JPG||height="318",width="900"}}
Line 120: Line 107:
You will find the data extraction tab – '''''Download''''' on the top menu bar. To access the download page, go to the '''PSE'''-tab and click '''Download'''.
Line 122: Line 109:
{{attachment:top_download3.png}} 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.
Line 124: Line 111:
The data can be extracted either in TOP or in AB format, independently of the format (AB or TOP) that it was submitted in. The data can be extracted either in TOP-format or in AB-format, independently of the format that it was submitted in.
Line 126: Line 113:
You can query the data by sex, breed and country. Breed and country are to be selected from the list. In order to select more than one criteria use ''CTRL+click'' 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.
Line 128: Line 115:
{{attachment:pse_extraction_2021.png}} 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.
Line 130: Line 117:
By default the system is extracting the data from the highest call rate per animal. However, if you tick the Full box, you will receive all the available records for queried combination.<<BR>> When all the extraction criteria are selected, click CREATE EXTRACTION.
Line 132: Line 119:
A very useful function, especially for the users downloading the data from GenoEx-PSE regularly, is a the time frame choice for data download, allowing to download only the data that was uploaded to the database within defined time period. {{attachment:5_download.JPG||height="680",width="900"}}
Line 134: Line 121:
Once the extraction criteria are selected, click '''''Create extraction'''''. You will see the progress on the screen, just like with the upload. When the extraction is completed you will be able to download your data as a zipped file containing snps.csv and meta.csv file. 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.
Line 136: Line 123:
{{attachment:extrfinal.png}} 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.
Line 138: Line 125:
The file can be downloaded right away or later on by finding specific case under '''''History '''''where the events are sorted by action date. {{attachment:6a_statusDownload_processing.JPG||height="414",width="901"}}

{{attachment:6b_statusDownload_finished.JPG||height="346",width="901"}}

== 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.

{{attachment:7_history_extraction.JPG||height="302",width="901"}}

GenoEx logo.png

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.

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.

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.

1_afterlogin.JPG

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.

2_upload.JPG

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.

3a_statusUpload_initating.JPG

3b_statusUpload_processing.JPG

3c_statusUpload_finished.JPG

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.

3d_statusUpload_failed.JPG

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.

5_download.JPG

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.

6a_statusDownload_processing.JPG

6b_statusDownload_finished.JPG

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.

7_history_extraction.JPG

More information about file formats and allowed values can be found here:

public/PSE_user_manual (last edited 2024-12-04 10:53:06 by MarcusPedersén)