hollorol/RBBGCMuso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Creating basic documentations for rungetMuso

Browse Source
This commit is contained in:
hollorol 2017-07-17 21:19:18 +02:00
parent 776f309517
commit c702d1000f
2 changed files with 59 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
RBBGCMuso/man/rungetMuso.Rd Normal file
View File

@ -0,0 +1,34 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rungetMuso.R
\name{rungetMuso}
\alias{rungetMuso}
\title{This function runs the BBGC-MuSo model and reads in its outputfile in a very structured way.}
\usage{
The function works only, if ...
}
\arguments{
\item{settings}{You have to run the setupMuso function before rungetMuso. It is its output which contains all of the necessary system variables. It sets the whole environment}
\item{timee}{The required timesteps in the modell output. It can be "d", if it is daily, "m", if it's monthly, "y", it it is yearly}
\item{debugging}{If it is TRUE, it copies the log file to a Log directory to store it, if it is stamplog it contatenate a number before the logfile, which is one more than the maximum of the represented ones in the LOG directory. If it is true or stamplog it collects the "wrong" logfiles}
\item{keepEpc}{If TRUE, it keeps the epc file and stamp it, after these copies it to the EPCS directory. If debugging True or false, it copies the wrong epc files to the wrong epc directory.}
\item{export}{if it is yes or you give a filename here, it converts the output to the specific extension. For example, if you set export to "example.csv", it converts the output to "csv", if you set it to "example.xls" it converts to example.xls with the xlsx package. If it is not installed it gives back a warning message and converts it to csv.}
\item{silent}{If you set it TRUE all off the modells output to the screen will be suppressed. It can be usefull, because it increases the model-speed.}
\item{aggressive}{It deletes every possible modell-outputs from the previous modell runs.}
\item{leapyear}{future feature.}
}
\value{
No return, outputs are written to file
}
\description{
This function runs the BBGC-MuSo model and reads in its outputfile in a very structured way.
}
\author{
Roland Hollós
}

25
RBBGCMuso/man/setupMuso.Rd Normal file
View File

@ -0,0 +1,25 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/setupMuso.R
\name{setupMuso}
\alias{setupMuso}
\title{This runs the BBGC-MuSo model}
\usage{
setupMuso(executable = NULL, parallel = F, calibrationpar = c(1),
outputloc = NULL, inputloc = NULL, metinput = NULL, CO2input = NULL,
plantinput = NULL, thininput = NULL, mowinput = NULL,
grazinput = NULL, harvinput = NULL, plouginput = NULL,
fertinput = NULL, irrinput = NULL, nitinput = NULL, ininput = NULL,
epcinput = NULL)
}
\arguments{
\item{calibrationpar}{vector with line numbers}
}
\value{
No return, outputs are written to file
}
\description{
This runs the BBGC-MuSo model
}
\author{
Roland Hollós
}