added rename and update comment instructions

vgl-hub · Jan 18, 2025 · 08a2be0 · 08a2be0
1 parent 99621de
commit 08a2be0
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 1 deletion.
diff --git a/gfalibs b/gfalibs
diff --git a/instructions/README.md b/instructions/README.md
@@ -91,6 +91,22 @@ The CLEAVE instruction breaks the specified segment at the given position genera
 CLEAVE  segment1 50  segment2 segment3 [edge1]
 ```
 
+## RENAME
+
+The RENAME instruction renames a path. It can be used to rename FASTA headers.
+
+```
+RENAME  path1   new_path
+```
+
+## COMMENT
+
+The COMMENT instruction add or replaces an existing comment associated with a specific path/header.
+
+```
+COMMENT  path1   comment
+```
+
 ## Yet to be implemented
 
 ```

diff --git a/testFiles/random1.comment.sak b/testFiles/random1.comment.sak
@@ -0,0 +1,5 @@
+COMMENT	Header3	This is header 3
+COMMENT	Header2	This is header 2
+COMMENT	Header5	This is header 5
+COMMENT	Header4	This is header 4
+COMMENT	Header1	This is header 1
diff --git a/testFiles/random1.rename.sak b/testFiles/random1.rename.sak
@@ -0,0 +1,5 @@
+RENAME	Header4	newHeader4
+RENAME	Header1	newHeader1
+RENAME	Header5	newHeader5
+RENAME	Header2	newHeader2
+RENAME	Header3	newHeader3
+4 −0		include/gfa.h
+20 −31		include/sak.h
+40 −97		src/gfa.cpp