knowledge

Documentation

Index

• func BuildKnowledgeGraphReport(graph ProjectKnowledgeGraph) string
• func ShortestPathIDs(graph ProjectKnowledgeGraph, fromID, toID string) ([]string, bool)
• type CitationEdge
• type GraphAnalysis
  • func AnalyzeProjectKnowledgeGraph(graph ProjectKnowledgeGraph) GraphAnalysis
• type GraphCommunity
• type GraphNodeMetric
• type KnowledgeEdge
• type KnowledgeNode
• type ProjectGraphInput
• type ProjectKnowledgeGraph
  • func BuildProjectKnowledgeGraph(input ProjectGraphInput) ProjectKnowledgeGraph
  • func BuildProjectKnowledgeGraphFromProject(projectPath string) (ProjectKnowledgeGraph, error)
  • func LoadProjectKnowledgeGraphFromProject(projectPath string) (ProjectKnowledgeGraph, error)
  • func QueryProjectKnowledgeGraph(graph ProjectKnowledgeGraph, term string) ProjectKnowledgeGraph
  • func ReadProjectKnowledgeGraphArtifact(projectPath string) (ProjectKnowledgeGraph, error)
  • func (g ProjectKnowledgeGraph) HasEdge(source, target, kind string) bool
  • func (g ProjectKnowledgeGraph) HasNode(id string) bool

Functions

func BuildKnowledgeGraphReport

func BuildKnowledgeGraphReport(graph ProjectKnowledgeGraph) string

func ShortestPathIDs

func ShortestPathIDs(graph ProjectKnowledgeGraph, fromID, toID string) ([]string, bool)

Types

type CitationEdge

type CitationEdge struct{ Source, Target string }

type GraphAnalysis

type GraphAnalysis struct {
	NodeCount    int
	EdgeCount    int
	CentralNodes []GraphNodeMetric
	Communities  []GraphCommunity
}

func AnalyzeProjectKnowledgeGraph

func AnalyzeProjectKnowledgeGraph(graph ProjectKnowledgeGraph) GraphAnalysis

type GraphCommunity

type GraphCommunity struct {
	ID      int
	NodeIDs []string
}

type GraphNodeMetric

type GraphNodeMetric struct {
	ID               string
	Label            string
	Kind             string
	Degree           int
	DegreeCentrality float64
	Betweenness      float64
}

type KnowledgeEdge

type KnowledgeEdge struct {
	ID     string `json:"id"`
	Source string `json:"source"`
	Target string `json:"target"`
	Kind   string `json:"kind"`
}

type KnowledgeNode

type KnowledgeNode struct {
	ID         string            `json:"id"`
	Kind       string            `json:"kind"`
	Label      string            `json:"label"`
	Properties map[string]string `json:"properties,omitempty"`
}

type ProjectGraphInput

type ProjectGraphInput struct {
	LibraryRecords   []library.PaperRecord
	CitationEdges    []CitationEdge
	ParsedDocuments  []parsing.ParsedDocument
	EvidenceItems    []evidence.EvidenceItem
	ScreeningEvents  []screening.DecisionEvent
	AnalysisRuns     []analysis.AnalysisRun
	ReportTrace      report.CitationEvidenceTraceView
	ProvenanceEvents []provenance.Event
}

type ProjectKnowledgeGraph

type ProjectKnowledgeGraph struct {
	SchemaVersion string          `json:"schemaVersion"`
	Nodes         []KnowledgeNode `json:"nodes"`
	Edges         []KnowledgeEdge `json:"edges"`
}

func BuildProjectKnowledgeGraph

func BuildProjectKnowledgeGraph(input ProjectGraphInput) ProjectKnowledgeGraph

func BuildProjectKnowledgeGraphFromProject

func BuildProjectKnowledgeGraphFromProject(projectPath string) (ProjectKnowledgeGraph, error)

func LoadProjectKnowledgeGraphFromProject

func LoadProjectKnowledgeGraphFromProject(projectPath string) (ProjectKnowledgeGraph, error)

func QueryProjectKnowledgeGraph

func QueryProjectKnowledgeGraph(graph ProjectKnowledgeGraph, term string) ProjectKnowledgeGraph

func ReadProjectKnowledgeGraphArtifact

func ReadProjectKnowledgeGraphArtifact(projectPath string) (ProjectKnowledgeGraph, error)

func (ProjectKnowledgeGraph) HasEdge

func (g ProjectKnowledgeGraph) HasEdge(source, target, kind string) bool

func (ProjectKnowledgeGraph) HasNode

func (g ProjectKnowledgeGraph) HasNode(id string) bool