From Genome Analysis Wiki
Jump to navigationJump to search
6 bytes added
, 14:01, 22 February 2010
Line 6: |
Line 6: |
| *** int minReadLength - The minimum length that a base sequence must be for it to be valid. | | *** int minReadLength - The minimum length that a base sequence must be for it to be valid. |
| *** int maxReportedErrors - The maximum number of errors that should be reported in detail before suppressing the errors. | | *** int maxReportedErrors - The maximum number of errors that should be reported in detail before suppressing the errors. |
− | *'''Open a FastQ File:''' openFile | + | *'''openFile''' : Open a FastQ File |
| ** Parameters: | | ** Parameters: |
| *** String filename - fastq file to be opened. | | *** String filename - fastq file to be opened. |
Line 15: |
Line 15: |
| ** Return Value | | ** Return Value |
| *** FastQStatus: FASTQ_SUCCESS if successfully opened, FASTQ_FAILURE if not. | | *** FastQStatus: FASTQ_SUCCESS if successfully opened, FASTQ_FAILURE if not. |
− | *'''Close a FastQ File:''' closeFile | + | *'''closeFile''' : Close a FastQ File |
| ** Parameters: NONE | | ** Parameters: NONE |
| ** Return Value | | ** Return Value |
| *** bool: FastQStatus - FASTQ_SUCCESS if successfully closed, FASTQ_FAILURE if not. | | *** bool: FastQStatus - FASTQ_SUCCESS if successfully closed, FASTQ_FAILURE if not. |
− | *'''Determine if a FastQ File is open Method:''' isOpen | + | *'''isOpen''' : Determine if a FastQ File is open Method |
| ** Parameters: NONE | | ** Parameters: NONE |
| ** Return Value | | ** Return Value |
| *** bool: true if a file is open, false if not. | | *** bool: true if a file is open, false if not. |
− | *'''Validate an entire FastQ File:''' validateFastQFile | + | *'''validateFastQFile''' : Validate an entire FastQ File |
| ** Parameters: | | ** Parameters: |
| *** String filename - fastq file to be validated. | | *** String filename - fastq file to be validated. |
Line 34: |
Line 34: |
| ** Notes: | | ** Notes: |
| *** Invalid information is printed to cout until maxReportedErrors is hit. | | *** Invalid information is printed to cout until maxReportedErrors is hit. |
− | *'''Read a FastQ Sequence From the File:''' readFastQSequence | + | *'''readFastQSequence''' : Read a FastQ Sequence From the File |
| ** Parameters: NONE | | ** Parameters: NONE |
| ** Return Value | | ** Return Value |
Line 40: |
Line 40: |
| ** Notes: | | ** Notes: |
| *** Invalid information is printed to cout until maxReportedErrors is hit. | | *** Invalid information is printed to cout until maxReportedErrors is hit. |
− | *'''Get the Space Type for the File:''' getSpaceType | + | *'''getSpaceType''' : Get the Space Type for the File |
| ** Parameters: NONE | | ** Parameters: NONE |
| ** Return Value | | ** Return Value |