diff --git a/gfa.cpp b/gfa.cpp index 341a44d..ec34b44 100644 --- a/gfa.cpp +++ b/gfa.cpp @@ -942,6 +942,7 @@ gfa_to_gbwt(const std::string& gfa_filename, const GFAParsingParameters& paramet } if(gfa_file.paths() > 0 && gfa_file.walks() > 0) { + // TODO: Add an option to index both paths and walks. if(parameters.show_progress) { std::cerr << "Indexing walks and ignoring paths" << std::endl; diff --git a/include/gbwtgraph/gfa.h b/include/gbwtgraph/gfa.h index db1a140..156bd6c 100644 --- a/include/gbwtgraph/gfa.h +++ b/include/gbwtgraph/gfa.h @@ -65,10 +65,14 @@ struct GFAParsingParameters 2. There are no containments. Link lines are ignored, and the edges are instead derived from the paths. + If the construction failes, the return value is `(nullptr, nullptr)`. The construction is done in several passes over a memory-mapped GFA file. The function returns the GBWT index and a sequence source for GBWTGraph construction. + If the GFA file contains both P-lines and W-lines, only W-lines will be used. + Metadata from P-lines and W-lines cannot be combined yet. + If there are segments longer than the maximum length specified in the parameters, such segments will be broken into nodes of that length. If segment identifiers are not positive integers, they will be translated into such identifiers. In both