Skip to content

Commit

Permalink
add doc again. #462
Browse files Browse the repository at this point in the history
  • Loading branch information
shenwei356 committed May 17, 2024
1 parent f56b39c commit 79f556b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2554,6 +2554,7 @@ Attention:
ensure the .fai file matches the FASTA file.
2. For splitting by sequence IDs in Windows/MacOS, where the file systems might be case-insensitive,
output files might be overwritten if they are only different in cases, like Abc and ABC.
To avoid this, please switch one -I/--ignore-case.
The definition of region is 1-based and with some custom design.
Expand Down
3 changes: 2 additions & 1 deletion seqkit/cmd/split.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Attention:
ensure the .fai file matches the FASTA file.
2. For splitting by sequence IDs in Windows/MacOS, where the file systems might be case-insensitive,
output files might be overwritten if they are only different in cases, like Abc and ABC.
To avoid this, please switch one -I/--ignore-case.
The definition of region is 1-based and with some custom design.
Expand Down Expand Up @@ -1029,7 +1030,7 @@ func init() {
splitCmd.Flags().IntP("by-size", "s", 0, "split sequences into multi parts with N sequences")
splitCmd.Flags().IntP("by-part", "p", 0, "split sequences into N parts")
splitCmd.Flags().BoolP("by-id", "i", false, "split squences according to sequence ID")
splitCmd.Flags().BoolP("ignore-case", "", false, "ignore case when using -i/--by-id")
splitCmd.Flags().BoolP("ignore-case", "I", false, "ignore case when using -i/--by-id")
splitCmd.Flags().StringP("by-region", "r", "", "split squences according to subsequence of given region. "+
`e.g 1:12 for first 12 bases, -12:-1 for last 12 bases. type "seqkit split -h" for more examples`)
splitCmd.Flags().BoolP("two-pass", "2", false, "two-pass mode read files twice to lower memory usage. (only for FASTA format)")
Expand Down

0 comments on commit 79f556b

Please sign in to comment.