csu_trend_legend {Rcan}

csu_trend_legend

Description

csu_trend_legend legend option use in Rcan package for trends.

Usage

csu_trend_legend(title=NULL, position="bottom",nrow=1, right_space_margin=1)

Arguments

title

Title of the legend. (only if position = "bottom").

position

Position of the legend:

"bottom"	The legend is place at the bottom of the graph. use with option nrow.
"right"	The legend is place at the right of each trend. use with option right_space_margin. If there is already a plot in the device, use plot.new() to avoid overprint

nrow

Number of row of the legend (only if position = "bottom").

right_space_margin

If the position = "right", the right margin need to be enough big, to contain the text legend. value should be between 1 and 10 depending the size of the text legend.

Details

This function return a list for the trend graphics of the package Rcan

Value

Return a structured list.

Author(s)

Mathieu Laversanne

See Also

csu_ageSpecific

Examples

data(csu_registry_data_1)

csu_ageSpecific(csu_registry_data_1,
                group_by="registry_label",
                legend=csu_trend_legend(title="registry", position="bottom", nrow = 2),
                plot_title = "Legend: bottom")
				
csu_ageSpecific(csu_registry_data_1,
                group_by="registry_label",
                legend=csu_trend_legend(position="right", right_space_margin = 2),
                plot_title = "Legend: right, cut")

csu_ageSpecific(csu_registry_data_1,
                group_by="registry_label",
                legend=csu_trend_legend(position="right", right_space_margin = 6.5),
                plot_title = "Legend: right")
				
#See more examples here:
help(csu_ageSpecific)