Branch creator: Difference between revisions

Revision as of 20:38, 12 March 2016

This page is a knowledge crystal of subtype method. The page identifier is Op_en7457
Moderator:Jouni (see all)

Upload data {{#opasnet_base_link:Op_en7457}}

Question

How to create a branch for handprinter?

Answer

Step 1: Create a page for branch

If the branch that you are working with already has a page, open the page for editing and go to step 2.

Open two copies of this page to your browser. Give a name to your branch and click to create a new page for it. On the other page, continue from step 2.

<createbox> break=yes width=50 buttonlabel=Create branch align=left </createbox>

Step 2: Fill in data about your branch

In step 2, you can create a new branch page or add more ovariables to an existing page. Fill in the form below, click to create content for the page, and copy-paste that onto the page you created in step 1.

Each branch is a model that consists of sub-models called ovariables. If you don´t know what they are, you should first read pages Ovariable and Modelling in Opasnet.

If you need more ovariables for your branch model, you can simply rerun this code. Just remember to copy-paste the previous content first, as it will be replaced by the new ovariables. Each ovariable has its own sub-heading under the heading "Rationale".

Do you want to create content for a new branch page?:

Do you want to create content for a new ovariable with data?:

Do you want to create content for a new ovariable with a formula?:

Content for a new branch page

What was the branch name again?:

What again is the name of the ovariable that is the final outcome of the branch?:

Content for a new ovariable with data

Give a short name (no spaces!) for an ovariable with data:

What is(are) the unit(s) of the data?:

Give a data table for the input variable.:
- paste table here -

Cancel

Give free-text rationale about what the data ovariable is and where the data comes from.:

Content for a new ovariable with formula

Give a short name (no spaces!) to an ovariable with a formula.:

What are the input (parent or upstream) ovariables for this ovariable? Format c('var1', 'var2'):

What is the formula that defines the calculations with the parents?:

Give free-text rationale about what the outcome variable is and how it is calculated.:

+ Show code - Hide code

# This is code Op_en7457/fill on page [[Branch creator]]
# Parameters:
## newpage: TRUE if a new page is being  created
## newdata: TRUE if a new data-based (from t2b) ovariable is being created
## newformula: TRUE if a new formula-based ovariable is being created
## branchname: name of the branch
## output.ovariable: name of the ovariable that calculates the final output of this branch. The name is used in the Answer code.
## data.ovariable: name of an ovariable that takes data as input
## unit: unit(s) of the data
## t2bdata: table of data to be converted in the data slot of the variable
## data.rationale: textbox of description for data.ovariable
## formula.ovariable: name of an ovariable based on formula and dependencies
## dependencies: character vector of the names of dependencies
## formula: the body of the formula (should contain the function 'return' in the end)
## formula.rationale: textbox of description for formula.ovariable

library(OpasnetUtils)

if(newpage) {

	newpage <- paste("[[Category:Life cycle assessment]]
		[[Category:Handprinter]]
		{{method|moderator=",
		wiki_username,
		"}}

		",
		"'''{{PAGENAME}}''' is a '''branch''' of Handprinter. This page is a test case how to manage branches.

		== Question ==

		How to estimate the life-cycle impacts of '''{{PAGENAME}}'''?

		== Answer ==

		¤rcode embed=1 variables='
		name:PAGEID|type:hidden|default:{{PAGEID}}
		'>
		# This is code Op_enXXXX/ on page [[",
		branchname,
		"]]
		library(OpasnetUtils)

		objects.latest(paste('Op_en', PAGEID, sep = ''), code_name = '",
		output.ovariable,
		"')

		",
		output.ovariable,
		" ¤- EvalOutput(",
		output.ovariable,
		")

		oprint(summary(",
		output.ovariable,
		"))

		¤/rcode>

		== Rationale ==

		",
		sep = ""
	)
}

if(newdata) {
	# Take the data out of the input
	dat <- as.matrix(t2bdata[-1 , ])
	dat <- apply(dat, 1, paste, collapse = "|")
	dat <- paste(dat, "
	",
	sep = "")

	# Find parameter values for t2b tag.
	cols <- as.matrix(t2bdata)[1 , ]

	# Find column(s) with results: has name Result, has semicolons, or is the last one.
	rescols <- tolower(cols) %in% "result"
	if(!any(rescols)) {
		rescols <- grepl(":", cols)
	}
	if(!any(rescols)) {
		rescols <- 1:length(cols) == length(cols)
	}

	# Indices are to the left from rescols, descriptions are to the right.
	firstres <- min(grep(TRUE, rescols))
	if(firstres > 1) indices <- cols[1:(firstres-1)] else indices <- character()
	lastres <- max(grep(TRUE, rescols))
	if(lastres < length(cols)) desc <- cols[(lastres+1):length(cols)] else desc <- character()

	resnames <- strsplit(cols[rescols], split = ":")

	# If only one rescol
	## If first is Splittable
	### If first is Result then no index, last is obs else add first as index, last is locations
	## If nonsplittable then no index, last is obs
	# If more than one rescol, then first is always splittable
	## Add first as index, last is locations
	if("result" == tolower(resnames[[1]][1]) | length(resnames[[1]]) == 1) {
		res <- paste(c("obs='", resnames[[1]][length(resnames[[1]])], "'"), collapse = "")
	} else {
		indices <- c(indices, resnames[[1]][1])
		resnames <- sapply(resnames, FUN = function(x) {return(x[length(x)])})
		res <- paste(c(" locations='", paste(resnames, collapse = ","), "'"), collapse = "")
	}
	if(length(indices) > 0) {
		indices <- paste(c("index='", paste(indices, collapse = ","), "'"), collapse = "")
	}
	if(length(desc) > 0) {
		desc <- paste(c("desc='", paste(desc, collapse = ","), "'"), collapse = "")
	}
	out <- paste(c(
		"¤t2b",
		paste(c("name='", data.ovariable, "'"), collapse = ""),
		indices,
		res,
		desc,
		paste(c("unit='", unit, "'"), collapse = ""),
		">"),
		collapse = " "
	)
	out <- c(out, "
		",
		dat, "¤/t2b>
		")

	newdata <- paste(c(
		"=== ",
		data.ovariable,
		" ===

		",
		out,
		"¤rcode name='",
		data.ovariable,
		"' embed=1 label='Initiate ",
		data.ovariable,
		" (for developers only)' variables='
		name:PAGEID|type:hidden|default:{{PAGEID}}
		'>
		# This is code Op_enXXXX/",
		data.ovariable,
		" on page [[",
		branchname,
		"]]
		library(OpasnetUtils)

		",
		data.ovariable,
		" ¤- Ovariable('",
		data.ovariable,
		"',
		  ddata = paste('Op_en', PAGEID, sep = ''),
		  subset = '",
		data.ovariable,
		"')

		objects.store(",
		data.ovariable,
		")
		cat('Object',",
		data.ovariable,
		"@name, 'stored.@@')
		",
		"¤/rcode>
		",

		data.rationale,
		"
		"),
		collapse = ""
	)
}

if(newformula) {

	newformula <- paste(
		"=== ",
		formula.ovariable,
		" ===

		¤rcode name='",
		formula.ovariable,
		"' embed=1 label='Initiate ",
		formula.ovariable,
		" (for developers only)'>
		# This is code Op_enXXXX/",
		formula.ovariable,
		" on page [[",
		branchname,
		"]]
		library(OpasnetUtils)

		",
		formula.ovariable,
		" ¤- Ovariable('",
		formula.ovariable,
		"',
		  dependencies = data.frame(
			Name = c('",
		paste(dependencies, collapse = "', '"),
		"')
		  ),
		  formula = function(...) {
			",
		gsub("<", "¤", formula),
		"  }
		)

		objects.store(",
		formula.ovariable,
		")
		cat('Object ',",
		formula.ovariable,
		"@name, ' stored.@@')
		¤/rcode>

		",
		formula.rationale,
		"

		",
		sep = ""
	)
}

finale <- paste(
	"== See also ==

	* [[Handprinter]]
	* [[Developing branches]]
	",
	"== Related files ==
	",
	sep = ""
)

text1 <- ""
if(!is.logical(newpage)) text1 <- paste(text1, newpage, collapse = "")
if(!is.logical(newdata)) text1 <- paste(text1, newdata, collapse = "")
if(!is.logical(newformula)) text1 <- paste(text1, newformula, collapse = "")
if(!is.logical(newpage)) text1 <- paste(text1, finale, collapse = "")

text2 <- strsplit(text1, split = "\n")[[1]]
text2 <- gsub("@@", "\\n", text2)
text2 <- data.frame(Pagetemplate = text2)

oprint(text2, include.rownames = FALSE)

Step 3. Finalize the page

In step 2, page content is compiled. You can rerun the step 2 code as many times as you need to define all the ovariables. Remember to copy-paste the outputs each time to the branch page.

In the end, you have to adjust the page content, because for security reasons some character combinations are not allowed in code output. In the text produced, there is a character "¤" where there should be "<". So, you should find and replace "¤" with "<" (use the button at the top-right corner of the edit window). Then you can save your page.

Related files

@@ Line 67: / Line 67: @@
 library(OpasnetUtils)
-#wiki_username <- "Jouni"
-#branchname <- "Garden tower branch"
-#PAGEID <- "1234"
-#formula.ovariable <- "gardentower"
-#data.ovariable <- "vegeproduction"
-#dependencies <- c("vegeproduction", "wasteproduction", "waterconsumption")
-#formula.rationale <- "Garden tower composts kitchen waste and turns it into soil."
-#data.rationale <- "vegeproduction is the amount of vegetables produced in the garden tower. It is a critical benefit that reduces consumption of other products and thus footprint."
-#<t2b name='Tire inflation parameters' index='Parameter,Unit' obs='Result' unit='-'>
-#Pressure drop per temperature drop|PSI /10°F|0.5:1:2
-#Fuel economy sensitivity|% /PSI|0.4
-#Miles driven per year|mi /a|10000
-#Fuel consumption|gl /mi|0.04
-#Pressure deficit|PSI|2
-#</t2b>
 if(newpage) {
@@ Line 314: / Line 297: @@
 text2 <- strsplit(text1, split = "\n")[[1]]
 text2 <- gsub("@@", "\\n", text2)
-#text2 <- gsub("¤", "<", text2)
 text2 <- data.frame(Pagetemplate = text2)
@@ Line 324: / Line 306: @@
 In step 2, page content is compiled. You can rerun the step 2 code as many times as you need to define all the ovariables. Remember to copy-paste the outputs each time to the branch page.
-In the end, you have to adjust the page content, because there is a tiny error that has not yet been fixed. In the text produced, there is an extra space in tags "< rcode" and "< /rcode" and sign "< -". You should find and replace them with "<rcode", "</rcode", and "<-", respectively. Then you can save your page.
+In the end, you have to adjust the page content, because for security reasons some character combinations are not allowed in code output. In the text produced, there is a character "¤" where there should be "<". So, you should find and replace "¤" with "<" (use the button at the top-right corner of the edit window). Then you can save your page.
 == See also ==