1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
|
/**
>HEADER
Copyright (c) 2013 Rob Patro robp@cs.cmu.edu
This file is part of Salmon.
Salmon is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Salmon is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Salmon. If not, see <http://www.gnu.org/licenses/>.
<HEADER
**/
#include <boost/thread/thread.hpp>
#include <iostream>
#include <fstream>
#include <vector>
#include <cstdint>
#include <cstring>
#include <cstdio>
#include <sstream>
#include <string>
#include <memory>
#include <functional>
#include <unordered_map>
#include <thread>
#include <boost/program_options.hpp>
#include <boost/program_options/parsers.hpp>
#include <boost/range/irange.hpp>
#include <boost/filesystem.hpp>
// C++ string formatting library
#include "spdlog/fmt/fmt.h"
#include "BiasIndex.hpp"
#include "SailfishUtils.hpp"
#include "GenomicFeature.hpp"
#include "SalmonConfig.hpp"
#include "VersionChecker.hpp"
int help(int argc, char* argv[]) {
fmt::MemoryWriter helpMsg;
helpMsg.write("Salmon v{}\n\n", salmon::version);
helpMsg.write("Usage: salmon -h|--help or \n"
" salmon -v|--version or \n"
" salmon [--no-version-check] <COMMAND> [-h | options]\n\n");
helpMsg.write("Commands:\n");
helpMsg.write(" index Create a salmon index\n");
helpMsg.write(" quant Quantify a sample\n");
helpMsg.write(" swim Perform super-secret operation\n");
/*
auto orighelpmsg = R"(
===============
Please invoke salmon with one of the following commands {index, quant, swim}.
For more information on the options for these particular methods, use the -h
flag along with the method name. For example:
salmon index -h
will give you detailed help information about the index command.
)";
*/
std::cerr << helpMsg.str();
return 1;
}
int dualModeMessage() {
auto helpmsg = R"(
===============
salmon quant has two modes --- one quantifies expression using raw reads
and the other makes use of already-aligned reads (in BAM/SAM format).
which algorithm is used depends on the arguments passed to salmon quant.
If you provide salmon with alignments '-a [ --alignments ]' then the
alignment-based algorithm will be used, otherwise the algorithm for
quantifying from raw reads will be used.
To view the help for salmon's alignment-based mode, use the command
salmon quant --help-alignment
to view the help for salmon's read-based mode, use the command
salmon quant --help-reads
)";
std::cerr << " Salmon v" << salmon::version << helpmsg << "\n";
return 1;
}
/**
* Bonus!
*/
int salmonSwim(int argc, char* argv[]) {
std::cerr << R"(
_____ __
/ ___/____ _/ /___ ___ ____ ____
\__ \/ __ `/ / __ `__ \/ __ \/ __ \
___/ / /_/ / / / / / / / /_/ / / / /
/____/\__,_/_/_/ /_/ /_/\____/_/ /_/
)";
return 0;
}
int salmonIndex(int argc, char* argv[]);
int salmonQuantify(int argc, char* argv[]);
int salmonAlignmentQuantify(int argc, char* argv[]);
bool verbose = false;
int main( int argc, char* argv[] ) {
using std::string;
namespace po = boost::program_options;
// With no arguments, print help
if (argc == 1) {
help(argc, argv);
std::exit(1);
}
try {
po::options_description hidden("hidden");
hidden.add_options()
("command", po::value<string>(), "command to run {index, quant, sf}");
po::options_description sfopts("Allowed Options");
sfopts.add_options()
("version,v", "print version string")
("no-version-check", "don't check with the server to see if this is the latest version")
("help,h", "produce help message")
;
po::options_description all("Allowed Options");
all.add(sfopts).add(hidden);
po::positional_options_description pd;
pd.add("command", 1);
size_t topLevelArgc = argc;
for (size_t i : boost::irange(size_t{1}, static_cast<size_t>(argc))) {
if (argv[i][0] != '-') {
topLevelArgc = i+1;
break;
}
}
po::variables_map vm;
po::parsed_options parsed = po::command_line_parser(topLevelArgc, argv).options(all).positional(pd).allow_unregistered().run();
po::store(parsed, vm);
if (vm.count("version")) {
std::cerr << "version : " << salmon::version << "\n";
std::exit(0);
}
if (vm.count("help") and !vm.count("command")) {
help(argc, argv);
std::exit(0);
}
//if (!vm.count("no-version-check")){
// std::string versionMessage = getVersionMessage();
// std::cerr << versionMessage;
//}
po::notify(vm);
std::unordered_map<string, std::function<int(int, char*[])>> cmds({
{"index", salmonIndex},
{"quant", salmonQuantify},
{"swim", salmonSwim}
});
string cmd = vm["command"].as<string>();
int subCommandArgc = argc - topLevelArgc + 1;
char** argv2 = new char*[subCommandArgc];
argv2[0] = argv[0];
std::copy_n( &argv[topLevelArgc], argc-topLevelArgc, &argv2[1] );
auto cmdMain = cmds.find(cmd);
if (cmdMain == cmds.end()) {
help(subCommandArgc, argv2);
} else {
// If the command is quant; determine whether
// we're quantifying with raw sequences or alignemnts
if (cmdMain->first == "quant") {
// detect mode-specific help request
if (strncmp(argv2[1], "--help-alignment", 16) == 0) {
std::vector<char> helpStr{'-','-','h','e','l','p','\0'};
char* helpArgv[] = {argv[0], &helpStr[0]};
salmonAlignmentQuantify(2, helpArgv);
} else if (strncmp(argv2[1], "--help-reads", 12) == 0) {
std::vector<char> helpStr{'-','-','h','e','l','p','\0'};
char* helpArgv[] = {argv[0], &helpStr[0]};
salmonQuantify(2, helpArgv);
}
// detect general help request
if (strncmp(argv2[1], "--help", 6) == 0 or
strncmp(argv2[1], "-h", 2) == 0) {
dualModeMessage();
std::exit(0);
}
// otherwise, detect and dispatch the correct mode
bool useSalmonAlign{false};
for (size_t i = 0; i < subCommandArgc; ++i) {
if (strncmp(argv2[i], "-a", 2) == 0 or
strncmp(argv2[i], "--alignments", 12) == 0) {
useSalmonAlign = true;
break;
}
}
if (useSalmonAlign) {
salmonAlignmentQuantify(subCommandArgc, argv2);
} else {
salmonQuantify(subCommandArgc, argv2);
}
} else {
cmdMain->second(subCommandArgc, argv2);
}
}
delete[] argv2;
} catch (po::error &e) {
std::cerr << "Program Option Error (main) : [" << e.what() << "].\n Exiting.\n";
std::exit(1);
} catch (...) {
std::cerr << argv[0] << " was invoked improperly.\n";
std::cerr << "For usage information, try " << argv[0] << " --help\nExiting.\n";
}
return 0;
}
|