sylly v0.1-2

0

Monthly downloads

0th

Percentile

Hyphenation and Syllable Counting for Text Analysis

Provides the hyphenation algorithm used for 'TeX'/'LaTeX' and similar software, as proposed by Liang (1983, <https://tug.org/docs/liang/>). Mainly contains the function hyphen() to be used for hyphenation/syllable counting of text objects. It was originally developed for and part of the 'koRpus' package, but later released as a separate package so it's lighter to have this particular functionality available for other packages. Support for various languages needs be added on-the-fly or by plugin packages; this package does not include any language specific data. Due to some restrictions on CRAN, the full package sources are only available from the project homepage. To ask for help, report bugs, request features, or discuss the development of the package, please subscribe to the koRpus-dev mailing list (<http://korpusml.reaktanz.de>).

Readme

sylly

Flattr this git repo

Provides the hyphenation algorithm used for 'TeX'/'LaTeX' and similar software, as proposed by Liang (1983). Mainly contains the function 'hyphen()' to be used for hyphenation/syllable counting of text objects. It was originally developed for and part of the 'koRpus' package, but later released as a separate package so it's lighter to have this particular functionality available for other packages. Support for additional languages can be added on-the-fly or by plugin packages. Due to some restrictions on CRAN, the full package sources are only available from the project homepage. To ask for help, report bugs, request features, or discuss the development of the package, please subscribe to the koRpus-dev mailing list.

More information on sylly is available on the project homepage.

Language support

This package contains class definitions, generic methods and tools for hyphenation, but no out-of-the-box support for any particular language. If you're interested in using the 'sylly' package for actual hyphenation, look for packages called 'sylly.XX', where 'XX' abbreviates the language you're looking for (e.g., 'sylly.en' for English or 'sylly.de' for German).

Installation

Installation via GitHub

To install the package directly from GitHub, you can use install_github() from the devtools package:

library(devtools)
install_github("unDocUMeantIt/sylly") # stable release
install_github("unDocUMeantIt/sylly", ref="develop") # development release

Contributing

To ask for help, report bugs, suggest feature improvements, or discuss the global development of the package, please either subscribe to the koRpus-dev mailing list, or use the issue tracker on GitHub.

Branches

Please note that all development happens in the develop branch. Pull requests against the master branch will be rejected, as it is reserved for the current stable release.

License

sylly Copyright (C) 2017 m.eik michalke, released under the GNU General Public License (GPL) version 3 or (at your option) any later version.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should have received a copy of the license with the source package as the file COPYING or LICENSE.

Functions in sylly

Name Description
manage.hyph.pat Handling hyphenation pattern objects
read.hyph.pat Reading patgen-compatible hyphenation pattern files
set.hyph.support Add support for new languages
set.sylly.env A function to set information on your sylly environment
kRp.hyphen,-class S4 Class kRp.hyphen
describe Getter/setter methods for sylly objects
hyphen Automatic hyphenation
kRp.hyph.pat,-class S4 Class kRp.hyph.pat
correct.hyph Correct kRp.hyphen objects
get.sylly.env Get sylly session environment
show,kRp.hyphen-method Show method for sylly objects
sylly-package The sylly Package
summary,kRp.hyphen-method Summary method for sylly objects
No Results!

Vignettes of sylly

Name
sylly_lit.bib
sylly_vignette.Rnw
No Results!

Last month downloads

Details

Type Package
License GPL (>= 3)
Encoding UTF-8
LazyLoad yes
URL https://reaktanz.de/?c=hacking&s=koRpus
BugReports https://github.com/unDocUMeantIt/sylly/issues
Date 2017-09-12
Collate '00_environment.R' '01_class_01_kRp.hyph.pat.R' '01_class_02_kRp.hyphen.R' '02_method_correct.R' '02_method_hyphen.R' '02_method_kRp.hyphen.R' '02_method_show.kRp.hyphen.R' '02_method_summary.kRp.hyphen.R' 'get.sylly.env.R' 'manage.hyph.pat.R' 'read.hyph.pat.R' 'set.hyph.support.R' 'set.sylly.env.R' 'sylly-internal.R' 'sylly-internal_langpack_generator.R' 'sylly-package.R'
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2017-09-12 11:02:16 UTC; m
Repository CRAN
Date/Publication 2017-09-12 17:33:13 UTC
imports methods
depends R (>= 3.0.0)
suggests testthat
Contributors

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/sylly)](http://www.rdocumentation.org/packages/sylly)