Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/keenwrite.git

Update README to point to example usages

AuthorDaveJarvis <email>
Date2020-05-18 09:05:24 GMT-0700
Commit3c1acdd07e5b5f126870e620bd8cd9b8bd9757a5
Parent4a45090
Delta19 lines added, 26 lines removed, 7-line decrease
README.md
# $application.title$
-Text editing using interpolated strings.
+A text editors that offers [interpolated strings](https://en.wikipedia.org/wiki/String_interpolation).
## Requirements
* XML document transformation using XSLT3 or older
* Platform independent (Windows, Linux, MacOS)
+
+## Usage
+
+See the following documents for more information:
+
+* [USAGE.md](USAGE.md) - how variable definitions and string interpolation work.
+* [USAGE-R.md](USAGE-R.md) - how to call R functions in R Markdown documents.
## Future Features
R/possessive.R
-# ######################################################################
-#
-# Copyright 2017, White Magic Software, Ltd.
+# -----------------------------------------------------------------------------
+# Copyright 2020, White Magic Software, Ltd.
#
# Permission is hereby granted, free of charge, to any person obtaining
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-# ######################################################################
-
-# ######################################################################
-#
-# Changes a word into its possessive form.
-#
-# ######################################################################
+# -----------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
# Returns leftmost n characters of s.
+# -----------------------------------------------------------------------------
lstr <- function( s, n = 1 ) {
substr( s, 0, n )
}
+# -----------------------------------------------------------------------------
# Returns rightmost n characters of s.
+# -----------------------------------------------------------------------------
rstr <- function( s, n = 1 ) {
l = nchar( s )
substr( s, l - n + 1, l )
}
-# Returns the possessive form of the given word.
+# -----------------------------------------------------------------------------
+# Returns the possessive form of the given word, s.
+# -----------------------------------------------------------------------------
pos <- function( s ) {
- result <- s
-
- # Check to see if the last character is an s.
- ch <- rstr( s, 1 )
-
- if( ch != "s" ) {
- result <- concat( result, "'s" )
- }
- else {
- result <- concat( result, "'" )
- }
-
- result
+ paste0( s, ifelse( rstr( s, 1 ) == 's', "'" ,"'s" ) )
}