Skip to content

Commit

Permalink
Regenerate help file through roxygenation process
Browse files Browse the repository at this point in the history
  • Loading branch information
rich-iannone committed Jan 24, 2015
1 parent 9eebbc6 commit 9b51012
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions man/trajectory_read.Rd
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/trajectory_read.R
\name{trajectory_read}
\alias{trajectory_read}
\title{Read HYSPLIT trajectory output files}
Expand All @@ -8,7 +9,7 @@ trajectory_read(archive_folder, year = NULL, start_height_m_AGL = NULL)
\arguments{
\item{archive_folder}{the absolute path and filename of the trajectory archive file (UNIX) or folder (Windows) is to be provided.}

\item{year}{providing a year will filter the list of trajectory endpoints files to be read into a data frame. This is usually only effective for filtering those trajectory endpoints files generated by SplitR using the the 'hysplit.trajectory' function since such files have a specified naming convention.}
\item{year}{providing a year will filter the list of trajectory endpoints files to be read into a data frame. This is usually only effective for filtering those trajectory endpoints files generated by SplitR using the the 'hysplit_trajectory' function since such files have a specified naming convention.}

\item{start_height_m_AGL}{providing a starting height will filter the list of trajectory endpoints files to be read into a data frame. This argument can be used in conjunction with the 'year' argument in order to filter a directory of endpoints files by year and by starting height. As with the 'year' argument, this option is usually only effective for filtering those trajectory endpoints files generated by SplitR.}
}
Expand Down

0 comments on commit 9b51012

Please sign in to comment.