| 8 | #include "CommonHelp.h" |
| 9 | |
| 10 | void sample_help(void) { |
| 11 | |
| 12 | cerr << "\nTool: bedtools sample (aka sampleFile)" << endl; |
| 13 | cerr << "Version: " << VERSION << "\n"; |
| 14 | cerr << "Summary: Take sample of input file(s) using reservoir sampling algorithm." << endl << endl; |
| 15 | |
| 16 | cerr << "Usage: " << "bedtools sample" << " [OPTIONS] -i <bed/gff/vcf/bam>" << endl << endl; |
| 17 | |
| 18 | cerr << "WARNING:\tThe current sample algorithm will hold all requested sample records in memory prior to output." << endl; |
| 19 | cerr << "\t\tThe user must ensure that there is adequate memory for this." << endl << endl; |
| 20 | cerr << "Options: " << endl; |
| 21 | |
| 22 | cerr << "\t-n\t" << "The number of records to generate." << endl; |
| 23 | cerr << "\t\t- Default = 1,000,000." << endl; |
| 24 | cerr << "\t\t- (INTEGER)" << endl << endl; |
| 25 | |
| 26 | cerr << "\t-seed\t" << "Supply an integer seed for the shuffling." << endl; |
| 27 | cerr << "\t\t- By default, the seed is chosen automatically." << endl; |
| 28 | cerr << "\t\t- (INTEGER)" << endl << endl; |
| 29 | |
| 30 | |
| 31 | cerr << "\t-ubam\t" << "Write uncompressed BAM output. Default writes compressed BAM." << endl << endl; |
| 32 | |
| 33 | cerr << "\t-s\t" << "Require same strandedness. That is, only give records" << endl; |
| 34 | cerr << "\t\tthat have the same strand. Use '-s forward' or '-s reverse'" << endl; |
| 35 | cerr << "\t\tfor forward or reverse strand records, respectively." << endl; |
| 36 | cerr << "\t\t- By default, records are reported without respect to strand." << endl << endl; |
| 37 | |
| 38 | cerr << "\t-header\t" << "Print the header from the input file prior to results." << endl << endl; |
| 39 | |
| 40 | allToolsCommonHelp(); |
| 41 | |
| 42 | cerr << "Notes: " << endl; |
| 43 | } |
| 44 | |
| 45 |
no test coverage detected