Skip to content

Commit

Permalink
First submission to CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
ezwelty committed Feb 17, 2015
1 parent b60ce65 commit c641597
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
^.*\.Rproj$
^\.Rproj\.user$
^cran_comments.*$
^temp$
^README\.Rmd$
^README-*\.png$
^NEWS\.md$
^cran-comments\.md$
^README-.*\.png$
12 changes: 6 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ Version: 0.1.0
Date: 2015-02-16
Authors@R: c(
person("Ethan Z.", "Welty", email = "[email protected]", role = c("aut", "cre")),
person("Christian E.", "Torgersen", role = "ctb", comment = "Contributed direction to the author."),
person("Samuel J.", "Brenkman", role = "ctb", comment = "Contributed the elwha and quinault datasets."),
person("Jeffrey J.", "Duda", role = "ctb", comment = "Contributed the elwha dataset."),
person("Jonathan B.", "Armstrong", role = "ctb", comment = "Contributed the fishmotion dataset."))
person("Christian E.", "Torgersen", role = "ctb", comment = "author support and guidance"),
person("Samuel J.", "Brenkman", role = "ctb", comment = "elwha and quinault datasets"),
person("Jeffrey J.", "Duda", role = "ctb", comment = "elwha dataset"),
person("Jonathan B.", "Armstrong", role = "ctb", comment = "fishmotion dataset"))
Type: Package
Depends: R (>= 3.0.1)
License: AGPL-3
Title: Binning and Plotting of Linearly Referenced Data
Description: Short for "linear binning", the linbin package provides functions for manipulating,
Description: Short for 'linear binning', the linbin package provides functions for manipulating,
binning, and plotting linearly referenced data. Although developed for data collected on river
networks, it can be used with any interval or point data referenced to a 1-dimensional coordinate
system. Flexible bin generation and batch processing makes it easy to compute and visualize
Expand All @@ -21,4 +21,4 @@ LazyData: true
Suggests: knitr
VignetteBuilder: knitr
URL: https://github.com/ezwelty/linbin
BugReports: https://github.com/ezwelty/linbin/issues
BugReports: https://github.com/ezwelty/linbin/issues
2 changes: 1 addition & 1 deletion R/event_creation.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Event Tables
#'
#' This function creates an event table, a custom \code{data.frame} used throughout the \code{linbin} package to store and manipulate linearly referenced data. Each row includes an event's endpoints \code{from} and \code{to} (which can be equal, to describe a point, or non-equal, to describe a line) and the values of any variables measured on that interval.
#' Creates an event table, a custom \code{data.frame} used throughout the \code{linbin} package to store and manipulate linearly referenced data. Each row includes an event's endpoints \code{from} and \code{to} (which can be equal, to describe a point, or non-equal, to describe a line) and the values of any variables measured on that interval.
#'
#' Event endpoints (and any additional arguments) are coerced to a data frame with \code{\link{data.frame}}, then coerced to an event table with \code{\link{as_events}}. A valid event table has two columns named "from" and "to" containing only finite numeric values (i.e., no \code{NA}, \code{NaN}, or \code{Inf}) and ordered such that \code{to} > or = \code{from}. \code{\link{is_events}} tests for these requirements. The other columns in the event table can be of any type supported by the \code{data.frame} class.
#'
Expand Down
1 change: 1 addition & 0 deletions linbin.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ RnwWeave: knitr
LaTeX: pdfLaTeX

BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageRoxygenize: rd,collate,namespace
2 changes: 1 addition & 1 deletion man/events.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ events(from = numeric(), to = numeric(), ...)
An event table, the \code{data.frame} object used by \code{linbin} to describe interval data.
}
\description{
This function creates an event table, a custom \code{data.frame} used throughout the \code{linbin} package to store and manipulate linearly referenced data. Each row includes an event's endpoints \code{from} and \code{to} (which can be equal, to describe a point, or non-equal, to describe a line) and the values of any variables measured on that interval.
Creates an event table, a custom \code{data.frame} used throughout the \code{linbin} package to store and manipulate linearly referenced data. Each row includes an event's endpoints \code{from} and \code{to} (which can be equal, to describe a point, or non-equal, to describe a line) and the values of any variables measured on that interval.
}
\details{
Event endpoints (and any additional arguments) are coerced to a data frame with \code{\link{data.frame}}, then coerced to an event table with \code{\link{as_events}}. A valid event table has two columns named "from" and "to" containing only finite numeric values (i.e., no \code{NA}, \code{NaN}, or \code{Inf}) and ordered such that \code{to} > or = \code{from}. \code{\link{is_events}} tests for these requirements. The other columns in the event table can be of any type supported by the \code{data.frame} class.
Expand Down

0 comments on commit c641597

Please sign in to comment.