Skip to content

Commit

Permalink
updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rebeccathomas-NOAA committed Aug 8, 2024
1 parent cd99ba3 commit 7c8736b
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 9 deletions.
3 changes: 2 additions & 1 deletion R/read_EVdir_exports.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@
#' The default is hakeflag=2, keeping just adult hake.
#'
#' @examples
#' \dontrun{
#' temp<-read_EV_exports(SurveyName, DirNameFile,database=1,exportloc=1)
#'
#' }
#' @export

read_EVdir_exports<-function(SurveyName, DirNameFile,database=1,exportloc=1,sheet=NULL,hakeflag=2,...){
Expand Down
8 changes: 5 additions & 3 deletions R/read_proc_reports.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@
#' Export_dir as the directory that the exported files are in.
#' @param sheet is an optional argument to denote which sheet of the DirNameFile
#' want to use. This defaults to the first sheet if not set.
#' @param hakeflag: adult hake (hakeflag=2), not filtering for hake (hakeflag=-1),
#' age-0 hake (hakeflag=0), age-1 hake only(hakeflag=1), all hake (hakeflag=3), age-1+ (hakeflag=4).
#' @param hakeflag: adult hake (hakeflag=2), not filtering for hake (hakeflag=-1),
#' age-0 hake (hakeflag=0), age-1 hake only(hakeflag=1), all hake (hakeflag=3), age-1+ (hakeflag=4).
#' set to 1 if want age1+ numbers, set to 0 (or other number) if want age2+. Defaults to age2+

#' @examples
#' \dontrun{
#' temp<-read_proc_reports(SurveyName, DirNameFile,sheet)
#' }
#'
#' @export
#'
Expand All @@ -33,7 +35,7 @@ read_proc_reports<-function(SurveyName, DirNameFile,sheet=NULL,hakeflag=2,...){
Exind<-44 #look here for age-2+
Agepath<-'Age2+'
}

#setup folders to read in data
ReportBasePath<-as.character(DirTable_yr$Report_Base_Path[1])
ReportYearPath<-file.path(ReportBasePath,'Reports',sheet,Agepath) #sheet is the case in this case
Expand Down
3 changes: 2 additions & 1 deletion R/read_proc_reports_abund.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@
#' set to 1 if want age1+ numbers, set to 0 (or other number) if want age2+. Defaults to age2+

#' @examples
#' \dontrun{
#' temp<-read_proc_reports_abund(SurveyName, DirNameFile,sheet, hakeflag)
#'
#' }
#' @export
#'

Expand Down
2 changes: 2 additions & 0 deletions R/read_proc_reports_abund_cross.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
#' Cannot read in age-1 biomass for age-2+ method. Method = 1 is for age-1+ method, method = 2
#' is for the age-2+ method.
#' @examples
#' \dontrun{
#' temp<-read_proc_reports_cross(SurveyName, DirNameFile,sheet,hakeflag, method)
#' }
#'
#' @export
#'
Expand Down
2 changes: 2 additions & 0 deletions R/read_spat_unkriged_reports.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
#' @param hakeflag. adult hake (hakeflag=2), not filtering for hake (hakeflag=-1),
#' age-0 hake (hakeflag=0), age-1 hake only (hakeflag=1), all hake (hakeflag=3), age-1+ (hakeflag=4).
#' @examples
#' \dontrun{
#' temp<-read_spat_unkriged_reports(SurveyName, DirNameFile,sheet,hakeflag=2)
#'}
#'
#' @export
#'
Expand Down
3 changes: 2 additions & 1 deletion man/read_EVdir_exports.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions man/read_proc_reports.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/read_proc_reports_abund.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/read_proc_reports_abund_cross.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/read_spat_unkriged_reports.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7c8736b

Please sign in to comment.