A toolkit for working with phylogenetic data.
v0.24.0
utils/containers/dataframe/operators.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_CONTAINERS_DATAFRAME_OPERATORS_H_
2 #define GENESIS_UTILS_CONTAINERS_DATAFRAME_OPERATORS_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2020 Lucas Czech and HITS gGmbH
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
35 
36 #include <string>
37 #include <vector>
38 
39 namespace genesis {
40 namespace utils {
41 
42 // =================================================================================================
43 // Conversion Functions
44 // =================================================================================================
45 
46 bool is_convertible_to_bool( Dataframe const& df, size_t col_index );
47 bool is_convertible_to_bool( Dataframe const& df, std::string const& col_name );
48 
49 bool is_convertible_to_double( Dataframe const& df, size_t col_index );
50 bool is_convertible_to_double( Dataframe const& df, std::string const& col_name );
51 
52 void convert_to_bool( Dataframe& df, size_t col_index );
53 void convert_to_bool( Dataframe& df, std::string const& col_name );
54 
55 void convert_to_double( Dataframe& df, size_t col_index );
56 void convert_to_double( Dataframe& df, std::string const& col_name );
57 
58 std::string summarize_column( Dataframe const& df, size_t col_index );
59 std::string summarize_column( Dataframe const& df, std::string const& col_name );
60 
61 std::string summarize_columns( Dataframe const& df );
62 
63 // =================================================================================================
64 // Merging and Combining
65 // =================================================================================================
66 
67 // enum class DataframeMergeMode
68 // {
69 // kExpectEqualRowNames,
70 // kUseRowNameIntersection,
71 // kUseRowNameUnion
72 // };
73 //
74 // void append(
75 // Dataframe& target,
76 // Dataframe const& appendix,
77 // size_t col_index,
78 // DataframeMergeMode mode = DataframeMergeMode::kExpectEqualRowNames
79 // );
80 //
81 // void append(
82 // Dataframe& target,
83 // Dataframe const& appendix,
84 // std::string const& col_name,
85 // DataframeMergeMode mode = DataframeMergeMode::kExpectEqualRowNames
86 // );
87 //
88 // void append(
89 // Dataframe& target,
90 // Dataframe const& appendix,
91 // DataframeMergeMode mode = DataframeMergeMode::kExpectEqualRowNames
92 // );
93 
94 // =================================================================================================
95 // Helpful Functions
96 // =================================================================================================
97 
98 bool validate( Dataframe const& df );
99 
100 } // namespace utils
101 } // namespace genesis
102 
103 #endif // include guard
bool is_convertible_to_double(Dataframe const &df, size_t col_index)
bool is_convertible_to_bool(Dataframe const &df, size_t col_index)
void convert_to_bool(Dataframe &df, size_t col_index)
Container namespace for all symbols of genesis in order to keep them separate when used as a library...
void convert_to_double(Dataframe &df, size_t col_index)
std::string summarize_columns(Dataframe const &df)
bool validate(Dataframe const &df)
Merge two Dataframes by appending the columns of the second one (appendix) to the first one (target)...
std::string summarize_column(Dataframe const &df, size_t col_index)