Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basthomas/analysis
A tool helping you to extract useful information from strings.
https://github.com/basthomas/analysis
analysis flesch-kincaid-grade-level flesch-reading-ease string swift syllable-count
Last synced: 17 days ago
JSON representation
A tool helping you to extract useful information from strings.
- Host: GitHub
- URL: https://github.com/basthomas/analysis
- Owner: BasThomas
- License: mit
- Created: 2016-11-11T14:32:41.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T09:13:15.000Z (about 2 months ago)
- Last Synced: 2024-10-16T15:26:33.489Z (about 1 month ago)
- Topics: analysis, flesch-kincaid-grade-level, flesch-reading-ease, string, swift, syllable-count
- Language: Swift
- Homepage:
- Size: 97.7 KB
- Stars: 122
- Watchers: 7
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: Readme.md
- Changelog: Changelog.md
- License: License
Awesome Lists containing this project
README
[](https://travis-ci.org/BasThomas/Analysis)
# Analysis
Analysis is a tool that helps you extract useful information from strings. It calculates the amount of sentences, words, characters, occurrence of words and characters, and more.
## Installation
Analysis is available via CocoaPods.
```ruby
pod 'Analysis'
```
Then run `pod install`.
## Sample Project
There's a sample project in the `Example` directory. To use it, run `pod install` to download the required libraries.
## Usage
Analysing a string is very straightforward. You can use any of these two ways to instantiate an `Analysis`:
```swift
import Analysis
let analysis = Analysis(of: "You are awesome, you!")
```
or
```swift
import Analysis
let analysis = "You are awesome, you!".analysed()
```
After that, you can get the information you need.
```swift
analysis.sentenceCount() // 1
analysis.wordCount(unique: true) // 4
analysis.characterCount(includingSpaces: false) // 18
analysis.wordOccurrences(caseSensitive: true) // ["You": 1, "are": 1, "awesome", 1, "you": 1]
analysis.wordOccurrences(caseSensitive: false) // ["you": 2, "are": 1, "awesome", 1]
analysis.frequency(of: "you", caseSensitive: false) // 50.0%
analysis.averageCharacters(per: .word) // 5.33
analysis.syllableCount() // 5
analysis.wordSyllables() // ["you": 1, "are": 1, "awesome": 2]
analysis.fleschReadingEase() // 97.025
analysis.fleschKincaidGradeLevel() // 0.72
```
You can also easily sort your occurences via an enhanced sorting method on `Dictionary`.
```swift
analysis
.wordOccurrences(caseSensitive: false)
.sorted(by: .key, order: .ascending) // [("are", 1), ("awesome", 1), ("you", 2)]
```
## Contributing
Want to contribute to this project? Great! There's some things that still need work, but definitely also let me know when you encounter any issues, spot a bug, or have a feature request!
Check out the issues for some tasks to get started with. Or, write tests. We can use as many as you can think of.
## License
Analysis is released under an MIT license. See [License](License) for more information.