Initial package setup

Author: marcusyoung

.Rbuildignore

@@ -0,0 +1,2 @@
+^.*\.Rproj$
+^\.Rproj\.user$

.gitignore

@@ -1,36 +1,3 @@
-# History files
+.Rproj.user
 .Rhistory
-.Rapp.history
-
-# Session Data files
 .RData
-
-# Example code in package build process
-*-Ex.R
-
-# Output files from R CMD build
-/*.tar.gz
-
-# Output files from R CMD check
-/*.Rcheck/
-
-# RStudio files
-.Rproj.user/
-
-# produced vignettes
-vignettes/*.html
-vignettes/*.pdf
-
-# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
-.httr-oauth
-
-# knitr and R markdown default cache directories
-/*_cache/
-/cache/
-
-# Temporary files created by R markdown
-*.utf8.md
-*.knit.md
-
-# Shiny token, see https://shiny.rstudio.com/articles/shinyapps.html
-rsconnect/

DESCRIPTION

@@ -0,0 +1,16 @@
+Package: opentripplanner
+Title: Open Trip Planner for R
+Version: 0.0.0.9000
+Authors@R: c(
+    person("Marcus", "Young", email = "[email protected]", role = c("aut", "cre")),
+    person("Malcolm", "Morgan", email = "[email protected]", role = c("aut"), comment = c(ORCID = "0000-0002-9488-9183")),
+    person("Robin", "Lovelace", role = c("ctb"))
+    )
+Description: An interface for Open Trip Planner <http://www.opentripplanner.org/>.
+    OpenTripPlanner (OTP) is an open source platform for multi-modal and multi-agency
+    journey planning written in Java. OTP provides a REST API which Open Trip Planner
+    for R uses to connect to OTP.
+License: GPL-3
+Encoding: UTF-8
+LazyData: true
+RoxygenNote: 6.0.1

NAMESPACE

@@ -0,0 +1,3 @@
+# Generated by roxygen2: do not edit by hand
+
+export(hello)

R/hello.R

@@ -0,0 +1,26 @@
+# Hello, world!
+#
+# This is an example function named 'hello'
+# which prints 'Hello, world!'.
+#
+# You can learn more about package authoring with RStudio at:
+#
+#   http://r-pkgs.had.co.nz/
+#
+# Some useful keyboard shortcuts for package authoring:
+#
+#   Build and Reload Package:  'Ctrl + Shift + B'
+#   Check Package:             'Ctrl + Shift + E'
+#   Test Package:              'Ctrl + Shift + T'
+
+#' Hello, World.
+#'
+#' Prints 'Hello World'.
+#'
+#' @examples
+#' hello()
+
+#' @export
+hello <- function() {
+  print("Hello, world!")
+}

README.md

@@ -1,2 +1,17 @@
-# otpr
-Development of an API wrapper for OpenTripPlanner (OTP) as an R package
+# Open Trip Planner for R
+
+The goal of Open Trip Planner for R is to provide a simple R interface to Open Trip Planner (OTP).
+
+## Installation - Open Trip Planner
+
+To use Open Trip Planner for R you will need a running instance of OTP. A basic tutorial on setting up OTP is available at http://docs.opentripplanner.org/en/latest/Basic-Tutorial/, and an intermediate tutorial complete with sample data is available at https://github.com/marcusyoung/otp-tutorial. 
+
+
+## Installation - R Package
+
+Install the package with **devtools** as follows:
+
+```{r install, eval=FALSE}
+# install.packages("devtools")
+devtools::install_github("marcusyoung/opentripplanner")
+```

man/hello.Rd

@@ -0,0 +1,21 @@
+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace