Save Contents of Issue #12 ("Reading AGEPRO INP Input File") as documentation

[efletcherPIFSC]

Create a Vignette or a Documentation Article about "Reading AGEPRO Input Files". This is based written on #12

[dendroica]

I am interested in an example of this as well; I tried ageproR::agepro_inp_model$read_inp(myfile) with myfile being my AGEPRO input file, but got the following error: "attempt to apply non-function"

A short tutorial/example showing how to read in an existing AGEPRO file would be most helpful!

[efletcherPIFSC]

@dendroica Thank you for your comment. Adding tutorial and function documentation #108 is helpful

Here is a reproducible example using agepro's included Example 1 input file,

library("ageproR")

# Load path of ageproR's included test Example1 Input File
inpfile <- file.path(find.package("ageproR"),"tests/testthat/example/Example1.INP")

# Load path of ageproR's included test Example1 Bootstrap File
bsnfile <- file.path(find.package("ageproR"),"tests/testthat/example/Example1.BSN")

# Create a agepro_inp_model with default values (This will 
test <- ageproR::agepro_inp_model$new()
# NOTE: This will give a WARNING that a NULL Recruitment Model is Found. This behavior is expected. 
# ageproR will check to see if agepro models will have NULL or invalid Recruitment models before being saved to file

# Set Recruit Models. 
test$set_recruit_model(c(14))
# NOTE: This will OVERWRITE the previous [RECRUIT] values.
# NOTE 2: Setting recruitment values depend on the number of recruits an agepro_model is initialized with. For example to set a `agepro_inp_model` with two Beverton-Holt and a single Ricker recruit:
test <- ageproR::agepro_inp_model$new(num_rec_models=3)
test$set_recruit_model(c(5,5,6)) 

# Save Path of Bootstrap File
test$set_bootstrap_filename(bsnfile)

# Save Input Files 
# Using tempfile() as example filepath
outfile <- tempfile("example1_", fileext = ".inp")
test$write_inp(outfile)

Note that when attempting to save AGERPRO input file, currently there is an error when ageproR is checking for options flags. Fixed in #110.

[dendroica]

thank you for this comment, initializing the model was the piece i was missing! for completeness sake I'll add this line of code for anyone else reading:
test$read_inp(inpfile)