https://github.com/aaronpeikert/stenographs.jl
Write meta graphs quickly
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.7%) to scientific vocabulary
Keywords
Repository
Write meta graphs quickly
Basic Info
- Host: GitHub
- Owner: aaronpeikert
- License: mit
- Language: Julia
- Default Branch: main
- Homepage: https://aaronpeikert.github.io/StenoGraphs.jl/
- Size: 601 KB
Statistics
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 12
- Releases: 9
Topics
Metadata Files
README.md
StenoGraphs.jl ― A concise language to write meta graphs
Stenography: a quick way of writing using special signs or abbreviations
StenoGraphs.jl lets you quickly write meta graphs. As with shorthand, it is optimized for writing quickly (by humans) but is less quickly read (by computers).
To install StenoGraphs.jl:
julia
import Pkg; Pkg.add("StenoGraphs")
Your first @StenoGraph using StenoGraphs:
julia
using StenoGraphs
@StenoGraph a → b
``` a → b
```
By the way, typing arrows can be done quickly on Linux by using Alt Gr + I resulting in ← and Alt GR + I resulting in → . All other platforms must use \leftarrow + Tab or \rightarrow + Tab.
Multiple Nodes
Multiple nodes on one side lead to multiple edges:
julia
@StenoGraph [a b] → c
``` a → c b → c
```
There are two desirable outcomes for multiple edges on both sides, either element-wise edges or cross-product. The single line arrow (→) means element-wise and double line arrow (⇒) means cross-product (don't tell anyone but for a single node on one side → is converted to ⇒ for convinience).
julia
@StenoGraph [a b] → [c d]
``` a → c b → d
```
julia
@StenoGraph [a b] ⇒ [c d]
``` a → c a → d b → c b → d
```
Modification
Modification is done by overloading * for types of Modifier.
Let's define a Modifier:
julia
struct Weight <: EdgeModifier
w::Number
end
An EdgeModifier can be directly applied to edges:
julia
@StenoGraph (a → b) * Weight(1)
``` a → b * Main.Weight(1)
```
Multiplying a Node with an EdgeModifier leads to a ModifyingNode.
julia
:b * Weight(1)
b * Main.Weight(1)
A ModifyingNode will modify its edges:
julia
@StenoGraph a → b * Weight(1)
``` a → b * Main.Weight(1)
```
To modify Nodes directly with a NodeModifier to create a ModifiedNode (instead of ModifyingNode) we overload ^:
```julia struct NodeLabel <: NodeModifier l end
@StenoGraph a → b^NodeLabel("Dickes B") ```
``` a → b^Main.NodeLabel("Dickes B")
```
Related Software
The R programming language has formulas of the form a ~ b to specify regressions. This inspired Yves Rosseel to create a very concise, yet expressive syntax for Structural Equation Models for lavaan. Stenographs.jl tries to maintain the best features of this syntax while creating Julia Objects that represent a graph (i.e., similar to MetaGraphs).
Owner
- Name: Aaron Peikert
- Login: aaronpeikert
- Kind: user
- Repositories: 15
- Profile: https://github.com/aaronpeikert
GitHub Events
Total
- Create event: 3
- Commit comment event: 8
- Release event: 2
- Issue comment event: 4
- Push event: 25
- Pull request event: 2
Last Year
- Create event: 3
- Commit comment event: 8
- Release event: 2
- Issue comment event: 4
- Push event: 25
- Pull request event: 2
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Aaron Peikert | a****t@p****e | 208 |
| leoniehagitte | 1****e | 2 |
| lkosanke | k****e@s****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 23
- Total pull requests: 41
- Average time to close issues: 20 days
- Average time to close pull requests: 1 day
- Total issue authors: 5
- Total pull request authors: 3
- Average comments per issue: 1.22
- Average comments per pull request: 0.8
- Merged pull requests: 37
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 4
- Average time to close issues: N/A
- Average time to close pull requests: 11 minutes
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.25
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- aaronpeikert (15)
- Maximilian-Stefan-Ernst (4)
- brandmaier (1)
- nickhaf (1)
- JuliaTagBot (1)
Pull Request Authors
- aaronpeikert (40)
- LeonieHagitte (1)
- lkosanke (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v2 composite
- codecov/codecov-action v2 composite
- julia-actions/cache v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest v1 composite
- julia-actions/setup-julia v1 composite
- actions/checkout v2 composite
- julia-actions/setup-julia latest composite
- actions/checkout v2 composite
- actions/github-script v5 composite
- julia-actions/setup-julia latest composite
- JuliaRegistries/TagBot v1 composite