FetchDataset
From SPCTools
| Revision as of 19:53, 2 November 2017 Edeutsch (Talk | contribs) ← Previous diff |
Current revision Luis (Talk | contribs) (→Documentation) |
||
| Line 5: | Line 5: | ||
| == Documentation == | == Documentation == | ||
| - | The fetchDataset system comes standard with TPP 5.1, but can be enabled manually on TPP 5.0. The fetchDataset systems is available in the TPP graphical user interface at the bottom of the second column of TPP Tools: | + | The ''fetchDataset'' system comes standard with TPP 5.1, but can be enabled manually on TPP 5.0. The ''fetchDataset'' system is available in the TPP graphical user interface at the bottom of the second column ("Utilities") under the '''TPP Tools''' menu: |
| + | |||
| + | [[Image:FetchDatasetsLink.png|400px]] | ||
| + | |||
| - | [[Image:FetchDatasetsLink.png]] | ||
| If you don't see that option present in the menu, we encourage you to upgrade to TPP 5.1. | If you don't see that option present in the menu, we encourage you to upgrade to TPP 5.1. | ||
| - | When you click on that option, you will see the fetchDataset interface: | ||
| - | [[Image:FetchDatasetsInterface.png]] | + | When you click on that option, you will see the ''fetchDataset'' interface: |
| + | |||
| + | [[Image:FetchDatasetsInterface.png|600px]] | ||
| + | |||
| - | The first recommended action is to check the current version and support by click in the '''[Show version information and available features]''' link at the top. If you are missing required components such that the Minid and BDBag software, we encourage you to install these components by following along in the tutorial below, which will lead you through the installation of components and testing of the interface with a sample dataset. | + | The first recommended action is to check the current version and support by clicking the '''[Show version information and available features]''' link at the top. If you are missing required components such as the ''Minid'' and ''BDBag'' software, we encourage you to install these components by following along in the tutorial below, which will lead you through the installation of components and testing of the interface with a sample dataset. |
| == Tutorial == | == Tutorial == | ||
| - | The following tutorial leads a user through the installation and testing of the TPP and the featchDataset system on a Windows system. The tutorial may also be used for a Linux system, but there will be some system-specific adjustments that must be made. | + | The following tutorial leads a user through the installation and testing of the TPP and the featchDataset system on a Windows system. The tutorial is also applicable to a Linux system, but changes to the path names will be to be made. |
| - | Link to tutorial | + | Download tutorial document: [http://www.peptideatlas.org/docs/fetchDataset/MinidDBBagFetchDatasetTutorial_v1.0.docx docx] [http://www.peptideatlas.org/docs/fetchDataset/MinidDBBagFetchDatasetTutorial_v1.0.pdf pdf] |
Current revision
Overview
The fetchDataset system allows you to download publicly available datasets easily for detailed examination or reprocessing on your TPP instance. The fetchDataset system supports the BDDS toolkit for Minids and BDBags (http://minid.bd2k.org), which enable easy downloading and transfer of data with identifiers, manifests, and checksums to ensure data integrity automatically.
Documentation
The fetchDataset system comes standard with TPP 5.1, but can be enabled manually on TPP 5.0. The fetchDataset system is available in the TPP graphical user interface at the bottom of the second column ("Utilities") under the TPP Tools menu:
If you don't see that option present in the menu, we encourage you to upgrade to TPP 5.1.
When you click on that option, you will see the fetchDataset interface:
The first recommended action is to check the current version and support by clicking the [Show version information and available features] link at the top. If you are missing required components such as the Minid and BDBag software, we encourage you to install these components by following along in the tutorial below, which will lead you through the installation of components and testing of the interface with a sample dataset.
Tutorial
The following tutorial leads a user through the installation and testing of the TPP and the featchDataset system on a Windows system. The tutorial is also applicable to a Linux system, but changes to the path names will be to be made.
