Skip to content

operations

create.network_data.from.tables

                                                                                
 Documentation                                                                  
                     Create a graph object from one or two tables.              
                                                                                
 Author(s)                                                                      
                     Markus Binsteiner   markus@frkl.io                         
                                                                                
 Context                                                                        
                     Tags         network_analysis                              
                     Labels       package: kiara_plugin.network_analysis        
                     References   source_repo:                                  
                                  https://github.com/DHARPA-Project/kiara_pl…   
                                  documentation:                                
                                  https://DHARPA-Project.github.io/kiara_plu…   
                                                                                
 Operation details                                                              
                     Documentation   Create a graph object from one or two      
                                     tables.                                    
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       edges   table   A       yes    -- no     
                                                       table          defa…     
                                                       that           --        
                                                       cont…                    
                                                       the                      
                                                       edges                    
                                                       data.                    
                                       sour…   stri…   The     no     sour…     
                                                       name                     
                                                       of                       
                                                       the                      
                                                       sour…                    
                                                       colu…                    
                                                       name                     
                                                       in                       
                                                       the                      
                                                       edges                    
                                                       tabl…                    
                                       targ…   stri…   The     no     targ…     
                                                       name                     
                                                       of                       
                                                       the                      
                                                       targ…                    
                                                       colu…                    
                                                       name                     
                                                       in                       
                                                       the                      
                                                       edges                    
                                                       tabl…                    
                                       edge…   dict    An      no     -- no     
                                                       opti…          defa…     
                                                       map            --        
                                                       of                       
                                                       orig…                    
                                                       colu…                    
                                                       name                     
                                                       to                       
                                                       desi…                    
                                       nodes   table   A       no     -- no     
                                                       table          defa…     
                                                       that           --        
                                                       cont…                    
                                                       the                      
                                                       nodes                    
                                                       data.                    
                                       id_c…   stri…   The     no     id        
                                                       name                     
                                                       (bef…                    
                                                       any                      
                                                       pote…                    
                                                       colu…                    
                                                       mapp…                    
                                                       of                       
                                                       the                      
                                                       node…                    
                                                       colu…                    
                                                       that                     
                                                       cont…                    
                                                       the                      
                                                       node                     
                                                       iden…                    
                                                       (used                    
                                                       in                       
                                                       the                      
                                                       edges                    
                                                       tabl…                    
                                       labe…   stri…   The     no     -- no     
                                                       name           defa…     
                                                       of a           --        
                                                       colu…                    
                                                       that                     
                                                       cont…                    
                                                       the                      
                                                       node                     
                                                       label                    
                                                       (bef…                    
                                                       any                      
                                                       pote…                    
                                                       colu…                    
                                                       name                     
                                                       mapp…                    
                                                       If                       
                                                       not                      
                                                       spec…                    
                                                       the                      
                                                       value                    
                                                       of                       
                                                       the                      
                                                       id                       
                                                       value                    
                                                       will                     
                                                       be                       
                                                       used                     
                                                       as                       
                                                       labe…                    
                                       node…   dict    An      no     -- no     
                                                       opti…          defa…     
                                                       map            --        
                                                       of                       
                                                       orig…                    
                                                       colu…                    
                                                       name                     
                                                       to                       
                                                       desi…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       network_d…   network_d…   The            
                                                                 network/g…     
                                                                 data.          
                                                                                
                                                                                
                                                                                

export.network_data.as.csv_files

                                                                                
 Documentation                                                                  
                     -- n/a --                                                  
                                                                                
 Author(s)                                                                      
                     Markus Binsteiner   markus@frkl.io                         
                                                                                
 Context                                                                        
                     Tags         network_analysis                              
                     Labels       package: kiara_plugin.network_analysis        
                     References   source_repo:                                  
                                  https://github.com/DHARPA-Project/kiara_pl…   
                                  documentation:                                
                                  https://DHARPA-Project.github.io/kiara_plu…   
                                                                                
 Operation details                                                              
                     Documentation   -- n/a --                                  
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       netw…   netw…   The     yes    -- no     
                                                       sour…          defa…     
                                                       valu…          --        
                                       base…   stri…   The     no     -- no     
                                                       dire…          defa…     
                                                       to             --        
                                                       expo…                    
                                                       the                      
                                                       file…                    
                                                       to.                      
                                       name    stri…   The     no     -- no     
                                                       (bas…          defa…     
                                                       name           --        
                                                       of                       
                                                       the                      
                                                       expo…                    
                                                       file…                    
                                       expo…   bool…   Whet…   no     False     
                                                       to                       
                                                       also                     
                                                       expo…                    
                                                       the                      
                                                       value                    
                                                       meta…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       export_detai…   dict   Details about     
                                                              the exported      
                                                              data/files.       
                                                                                
                                                                                
                                                                                

export.network_data.as.sql_dump

                                                                                
 Documentation                                                                  
                     -- n/a --                                                  
                                                                                
 Author(s)                                                                      
                     Markus Binsteiner   markus@frkl.io                         
                                                                                
 Context                                                                        
                     Tags         network_analysis                              
                     Labels       package: kiara_plugin.network_analysis        
                     References   source_repo:                                  
                                  https://github.com/DHARPA-Project/kiara_pl…   
                                  documentation:                                
                                  https://DHARPA-Project.github.io/kiara_plu…   
                                                                                
 Operation details                                                              
                     Documentation   -- n/a --                                  
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       netw…   netw…   The     yes    -- no     
                                                       sour…          defa…     
                                                       valu…          --        
                                       base…   stri…   The     no     -- no     
                                                       dire…          defa…     
                                                       to             --        
                                                       expo…                    
                                                       the                      
                                                       file…                    
                                                       to.                      
                                       name    stri…   The     no     -- no     
                                                       (bas…          defa…     
                                                       name           --        
                                                       of                       
                                                       the                      
                                                       expo…                    
                                                       file…                    
                                       expo…   bool…   Whet…   no     False     
                                                       to                       
                                                       also                     
                                                       expo…                    
                                                       the                      
                                                       value                    
                                                       meta…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       export_detai…   dict   Details about     
                                                              the exported      
                                                              data/files.       
                                                                                
                                                                                
                                                                                

export.network_data.as.sqlite_db

                                                                                
 Documentation                                                                  
                     -- n/a --                                                  
                                                                                
 Author(s)                                                                      
                     Markus Binsteiner   markus@frkl.io                         
                                                                                
 Context                                                                        
                     Tags         network_analysis                              
                     Labels       package: kiara_plugin.network_analysis        
                     References   source_repo:                                  
                                  https://github.com/DHARPA-Project/kiara_pl…   
                                  documentation:                                
                                  https://DHARPA-Project.github.io/kiara_plu…   
                                                                                
 Operation details                                                              
                     Documentation   -- n/a --                                  
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       netw…   netw…   The     yes    -- no     
                                                       sour…          defa…     
                                                       valu…          --        
                                       base…   stri…   The     no     -- no     
                                                       dire…          defa…     
                                                       to             --        
                                                       expo…                    
                                                       the                      
                                                       file…                    
                                                       to.                      
                                       name    stri…   The     no     -- no     
                                                       (bas…          defa…     
                                                       name           --        
                                                       of                       
                                                       the                      
                                                       expo…                    
                                                       file…                    
                                       expo…   bool…   Whet…   no     False     
                                                       to                       
                                                       also                     
                                                       expo…                    
                                                       the                      
                                                       value                    
                                                       meta…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       export_detai…   dict   Details about     
                                                              the exported      
                                                              data/files.       
                                                                                
                                                                                
                                                                                

import.network_data.from.csv_files

                                                                                
 Documentation                                                                  
                     Load the edges table from a csv file.                      
                                                                                
 Author(s)                                                                      
                     Markus Binsteiner   markus@frkl.io                         
                                                                                
 Context                                                                        
                     Labels       package: kiara                                
                     References   source_repo:                                  
                                  https://github.com/DHARPA-Project/kiara       
                                  documentation:                                
                                  https://dharpa.org/kiara_documentation/       
                                                                                
 Operation details                                                              
                     Documentation   Load the edges table from a csv file.      
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       path    stri…   The     yes    -- no     
                                                       local          defa…     
                                                       path           --        
                                                       to                       
                                                       the                      
                                                       file.                    
                                       impo…   stri…   The     yes    -- no     
                                                       local          defa…     
                                                       path           --        
                                                       to                       
                                                       the                      
                                                       file.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type    description      
                                      ──────────────────────────────────────    
                                       imported_edg…   file    The loaded       
                                                               files.           
                                       edges_table     table   The result       
                                                               value.