diff --git a/ledgerr.Rproj b/ledgerr.Rproj index d063e8b..d6ff804 100644 --- a/ledgerr.Rproj +++ b/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 diff --git a/ledgerr/DESCRIPTION b/ledgerr/DESCRIPTION index e582a12..2c64ae6 100644 --- a/ledgerr/DESCRIPTION +++ b/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. -Depends: R (>= 3.2.4) -License: GNU Affero General Public Licenseā€ version 3 (AGPL-3) +Description: This package acts as a frontend for simple bookkeeping spreadsheets + and provides functions for reports. +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 diff --git a/ledgerr/NAMESPACE b/ledgerr/NAMESPACE index 884a631..e6f4cb7 100644 --- a/ledgerr/NAMESPACE +++ b/ledgerr/NAMESPACE @@ -1,2 +1,5 @@ -# Generated by roxygen2: fake comment so roxygen2 overwrites silently. -exportPattern("^[^\\.]") +# Generated by roxygen2: do not edit by hand + +export(net) +export(net.acc) +export(net.class) diff --git a/ledgerr/R/net.R b/ledgerr/R/net.R index dee9701..70925e8 100644 --- a/ledgerr/R/net.R +++ b/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", diff --git a/ledgerr/R/net.acc.R b/ledgerr/R/net.acc.R index fdc5774..d679607 100644 --- a/ledgerr/R/net.acc.R +++ b/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", diff --git a/ledgerr/R/net.class.R b/ledgerr/R/net.class.R index eba2bc5..11f1359 100644 --- a/ledgerr/R/net.class.R +++ b/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", diff --git a/ledgerr/man/net.Rd b/ledgerr/man/net.Rd new file mode 100644 index 0000000..e9a26bc --- /dev/null +++ b/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} + diff --git a/ledgerr/man/net.acc.Rd b/ledgerr/man/net.acc.Rd new file mode 100644 index 0000000..ef9b09e --- /dev/null +++ b/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} + diff --git a/ledgerr/man/net.class.Rd b/ledgerr/man/net.class.Rd new file mode 100644 index 0000000..5cacaff --- /dev/null +++ b/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} +