ledgerr.Rproj

@@ -11,3 +11,9 @@ Encoding: UTF-8
 
 RnwWeave: knitr
 LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackagePath: ledgerr
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace

ledgerr/DESCRIPTION

@@ -1,9 +1,12 @@
 Package: ledgerr
-Title: R Functions For Bookkeeping (one line, title case)
+Title: R Functions For Bookkeeping
 Version: 0.0.0.9000
 Authors@R: person("Matt", "Burton-Kelly", email = "bedrocks@gmail.com", role = c("aut", "cre"))
-Description: This package acts as a frontend for simple bookkeeping spreadsheets and provides functions for reports.
+Description: This package acts as a frontend for simple bookkeeping spreadsheets
-Depends: R (>= 3.2.4)
+    and provides functions for reports.
-License: GNU Affero General Public License” version 3 (AGPL-3)
+Depends:
+    R (>= 3.2.4)
+License: GNU Affero General Public License version 3 (AGPL-3)
 Encoding: UTF-8
 LazyData: true
+RoxygenNote: 5.0.1.9000

ledgerr/NAMESPACE

@@ -1,2 +1,5 @@
-# Generated by roxygen2: fake comment so roxygen2 overwrites silently.
+# Generated by roxygen2: do not edit by hand
-exportPattern("^[^\\.]")
+
+export(net)
+export(net.acc)
+export(net.class)

ledgerr/R/net.R

@@ -1,3 +1,14 @@
+#' Calculate net 
+#' 
+#' This function reads in your journal, subsets it according to queries, and calculates net.
+#' @param journ Journal dataframe
+#' @param classselect Which classes to include. c("class1","class2",...). Defaults to "all".
+#' @param accselect Which accounts to include. c("class1","class2",...). Defaults to "all".
+#' @param dates Date range to include. c("2014-01-01","2014-12-31"). Defaults to "all".
+#' @keywords net
+#' @export
+#' @examples
+#' net()
 net<-function(journ,
               classselect="all",
               accselect="all",

ledgerr/R/net.acc.R

@@ -1,3 +1,14 @@
+#' Calculate net per account and present as a table
+#' 
+#' This function reads in your journal, subsets it according to queries, calculates net for each account, and prints a table..
+#' @param journ Journal dataframe
+#' @param classselect Which classes to include. c("class1","class2",...). Defaults to "all".
+#' @param accselect Which accounts to include. c("class1","class2",...). Defaults to "all".
+#' @param dates Date range to include. c("2014-01-01","2014-12-31"). Defaults to "all".
+#' @keywords net account
+#' @export
+#' @examples
+#' net.account()
 net.acc<-function(journ,
                   classselect="all",
                   accselect="all",

ledgerr/R/net.class.R

@@ -1,3 +1,14 @@
+#' Calculate net per class and present as a table
+#' 
+#' This function reads in your journal, subsets it according to queries, calculates net for each class, and prints a table..
+#' @param journ Journal dataframe
+#' @param classselect Which classes to include. c("class1","class2",...). Defaults to "all".
+#' @param accselect Which accounts to include. c("class1","class2",...). Defaults to "all".
+#' @param dates Date range to include. c("2014-01-01","2014-12-31"). Defaults to "all".
+#' @keywords net class
+#' @export
+#' @examples
+#' net.class()
 net.class<-function(journ,
                     classselect="all",
                     accselect="all",

ledgerr/man/net.Rd

@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/net.R
+\name{net}
+\alias{net}
+\title{Calculate net}
+\usage{
+net(journ, classselect = "all", accselect = "all", dates = "all")
+}
+\arguments{
+\item{journ}{Journal dataframe}
+
+\item{classselect}{Which classes to include. c("class1","class2",...). Defaults to "all".}
+
+\item{accselect}{Which accounts to include. c("class1","class2",...). Defaults to "all".}
+
+\item{dates}{Date range to include. c("2014-01-01","2014-12-31"). Defaults to "all".}
+}
+\description{
+This function reads in your journal, subsets it according to queries, and calculates net.
+}
+\examples{
+net()
+}
+\keyword{net}
+

ledgerr/man/net.acc.Rd

@@ -0,0 +1,27 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/net.acc.R
+\name{net.acc}
+\alias{net.acc}
+\title{Calculate net per account and present as a table}
+\usage{
+net.acc(journ, classselect = "all", accselect = "all", dates = "all",
+  total = F)
+}
+\arguments{
+\item{journ}{Journal dataframe}
+
+\item{classselect}{Which classes to include. c("class1","class2",...). Defaults to "all".}
+
+\item{accselect}{Which accounts to include. c("class1","class2",...). Defaults to "all".}
+
+\item{dates}{Date range to include. c("2014-01-01","2014-12-31"). Defaults to "all".}
+}
+\description{
+This function reads in your journal, subsets it according to queries, calculates net for each account, and prints a table..
+}
+\examples{
+net.account()
+}
+\keyword{account}
+\keyword{net}
+

ledgerr/man/net.class.Rd

@@ -0,0 +1,27 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/net.class.R
+\name{net.class}
+\alias{net.class}
+\title{Calculate net per class and present as a table}
+\usage{
+net.class(journ, classselect = "all", accselect = "all", dates = "all",
+  total = F)
+}
+\arguments{
+\item{journ}{Journal dataframe}
+
+\item{classselect}{Which classes to include. c("class1","class2",...). Defaults to "all".}
+
+\item{accselect}{Which accounts to include. c("class1","class2",...). Defaults to "all".}
+
+\item{dates}{Date range to include. c("2014-01-01","2014-12-31"). Defaults to "all".}
+}
+\description{
+This function reads in your journal, subsets it according to queries, calculates net for each class, and prints a table..
+}
+\examples{
+net.class()
+}
+\keyword{class}
+\keyword{net}
+