17. mzPeak metadata file description¶
Describe the JSON format of the file description section
Type: object
17.1 Properties¶
| Property | Type | Required | Description |
|---|---|---|---|
contents |
array of param |
Yes | Parameters describing the contents of the file, such as types of spectra. Analogous to https://peptideatlas.org/tmp/mzML1.1.0.html#fileContent |
source_files |
array of 17.3.1 source_file |
Yes | List of all files used as data sources for this mzPeak file. Analogous to https://peptideatlas.org/tmp/mzML1.1.0.html#sourceFileList |
contacts |
array of 17.3.2 contact |
Persons or entities responsible for the data contained here. |
17.2 Property Details¶
contents - array of param (required)
Parameters describing the contents of the file, such as types of spectra. Analogous to https://peptideatlas.org/tmp/mzML1.1.0.html#fileContent
source_files - array of 17.3.1 source_file (required)
List of all files used as data sources for this mzPeak file. Analogous to https://peptideatlas.org/tmp/mzML1.1.0.html#sourceFileList
contacts - array of 17.3.2 contact (optional)
Persons or entities responsible for the data contained here.
17.3 Definitions¶
17.3.1 source_file¶
A data file that was read in order to produce this mzPeak file. Analogous to https://peptideatlas.org/tmp/mzML1.1.0.html#sourceFile
Type: object
17.3.1.1 Properties¶
| Property | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | A unique identifier for this source file. |
name |
string |
Yes | The name of the source file, not including parent directory |
location |
string |
Yes | The path to the source file, URI encoded. This may include file:// protocols and UNC paths |
parameters |
array of param |
Yes | Additional parameters describing this source file, like checksums, nativeID format, or file format |
17.3.1.2 Property Details¶
id - string (required)
A unique identifier for this source file.
name - string (required)
The name of the source file, not including parent directory
location - string (required)
The path to the source file, URI encoded. This may include file:// protocols and UNC paths
parameters - array of param (required)
Additional parameters describing this source file, like checksums, nativeID format, or file format
17.3.2 contact¶
A person or entity that is responsible for some portion of the data or processing that resulted in this archive. Analogous to https://peptideatlas.org/tmp/mzML1.1.0.html#contact
Type: object
17.3.2.1 Properties¶
| Property | Type | Required | Description |
|---|---|---|---|
contact_name |
string |
The name of the contact person. This is equivalent to MS:1000586|contact name (http://purl.obolibrary.org/obo/MS_1000586) |
|
contact_affiliation |
string |
The home institute of the contact person. This is equivalent to MS:1000590|contact affiliation (http://purl.obolibrary.org/obo/MS_1000590) |
|
parameters |
array of param |
Yes | Parameters describing the contact, such as name, organization, email, website, or address. |
17.3.2.2 Property Details¶
contact_name - string (optional)
The name of the contact person. This is equivalent to MS:1000586|contact name (http://purl.obolibrary.org/obo/MS_1000586)
contact_affiliation - string (optional)
The home institute of the contact person. This is equivalent to MS:1000590|contact affiliation (http://purl.obolibrary.org/obo/MS_1000590)
parameters - array of param (required)
Parameters describing the contact, such as name, organization, email, website, or address.