From: Frederik Vanrenterghem <frederikv@fairgofinance.com.au>
Date: Tue, 10 May 2016 12:35:20 +0000 (+0800)
Subject: Fixed documentation.
X-Git-Url: http://git.vanrenterghem.biz/R/operatingdays.git/commitdiff_plain/27aa1e25ea0c4c8fd6fbb13df8dd3b1fba3731e7

Fixed documentation.
---

diff --git a/DESCRIPTION b/DESCRIPTION
index 03aa672..02acffb 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -4,7 +4,10 @@ Title: Return Number of Operating Days in Month
 Version: 0.1.0
 Author: Frederik Vanrenterghem
 Maintainer: Frederik Vanrenterghem <frederik@vanrenterghem.biz>
-Description: Return the number of operating days in a given month. Currently returns remaining days in current month.
-Depends: RCurl
+Description: Return the number of operating days in a given month. Currently
+    returns remaining days in current month.
+Depends:
+    RCurl
 License: GPL-3
 LazyData: TRUE
+RoxygenNote: 5.0.1
diff --git a/NAMESPACE b/NAMESPACE
index d75f824..6ae9268 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1 +1,2 @@
-exportPattern("^[[:alpha:]]+")
+# Generated by roxygen2: do not edit by hand
+
diff --git a/R/getRemainingOpDays.R b/R/getRemainingOpDays.R
index 9325670..eae5c87 100644
--- a/R/getRemainingOpDays.R
+++ b/R/getRemainingOpDays.R
@@ -1,8 +1,13 @@
-# getRemainingOpDays
+#' getRemainingOpDays
 # This is a function that returns the remaining operating days in a month
 # It takes as arguments the country, state, date for which the request is made.
 # It returns a number
 # It currently only supports AU (Australia)
+#' @param country A country - use ISO format (currently only takes AU)
+#' @param state A state - use 2 or 3 letter abbreviation, in capitals
+#' @param date A date from which the remaining operating days in the month will be counted
+#' @return The number of remaining operating days in \code{state}, \code{country} as of \code{date}
+#' @examples getRemainingOpDays("AU","WA","2016-05-10")
 
 getRemainingOpDays <- function(country,state,date) {
   cutoff.time = "15:00"
diff --git a/man/getRemainingOpDays.Rd b/man/getRemainingOpDays.Rd
new file mode 100644
index 0000000..7e2b271
--- /dev/null
+++ b/man/getRemainingOpDays.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/getRemainingOpDays.R
+\name{getRemainingOpDays}
+\alias{getRemainingOpDays}
+\title{getRemainingOpDays}
+\usage{
+getRemainingOpDays(country, state, date)
+}
+\arguments{
+\item{country}{A country - use ISO format (currently only takes AU)}
+
+\item{state}{A state - use 2 or 3 letter abbreviation, in capitals}
+
+\item{date}{A date from which the remaining operating days in the month will be counted}
+}
+\value{
+The number of remaining operating days in \code{state}, \code{country} as of \code{date}
+}
+\description{
+getRemainingOpDays
+}
+\examples{
+getRemainingOpDays("AU","WA","2016-05-10")
+}
+
diff --git a/operatingdays.Rproj b/operatingdays.Rproj
index 497f8bf..270314b 100644
--- a/operatingdays.Rproj
+++ b/operatingdays.Rproj
@@ -18,3 +18,4 @@ StripTrailingWhitespace: Yes
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace