← Back to branch summary

~ubuntu-branches/ubuntu/trusty/fportfolio/trusty

« back to all changes in this revision

Viewing changes to man/weightsLinePlot.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2008-12-04 11:36:54 UTC
  • mfrom: (1.1.6 upstream) (2.1.3 squeeze)
  • Revision ID: james.westby@ubuntu.com-20081204113654-gr832nfs44blp5ph
Tags: 280.74-1
* New upstream release
* Finally uploading as r-cran-rglpk is out of NEW after five weeks

* debian/control: Updated (Build-)Depends: and Suggests:

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/weightsLinePlot.Rd
 
1
\name{weightsLinePlot}
 
2
 
 
3
 
 
4
\alias{weightsLinePlot}
 
5
 
 
6
\alias{weightedReturnsLinePlot}
 
7
\alias{covRiskBudgetsLinePlot}
 
8
%\alias{tailRiskBudgetsLinePlot}
 
9
 
 
10
 
 
11
\title{Portfolio Weights Line Plots}
 
12
 
 
13
 
 
14
\description{
 
15
 
 
16
    Displays line plots of weights, weighted returns, covariance 
 
17
    and tail risk budgets.
 
18
 
 
19
}
 
20
 
 
21
 
 
22
\usage{   
 
23
weightsLinePlot(object, labels = TRUE, col = NULL, title = TRUE, 
 
24
    box = TRUE, legend = TRUE, ...)
 
25
    
 
26
weightedReturnsLinePlot(object, labels = TRUE, col = NULL, title = TRUE, 
 
27
    box = TRUE, legend = TRUE, ...)
 
28
    
 
29
covRiskBudgetsLinePlot(object, labels = TRUE, col = NULL, title = TRUE, 
 
30
    box = TRUE, legend = TRUE, ...)
 
31
% NYI   
 
32
%tailRiskBudgetsLinePlot(object, labels = TRUE, col = NULL, title = TRUE, 
 
33
%    box = TRUE, legend = TRUE, ...)
 
34
}
 
35
 
 
36
 
 
37
\arguments{
 
38
 
 
39
    \item{object}{
 
40
        an S4 object of class \code{fPORTFOLIO}, as returned by one of
 
41
        the portfolio functions, e.g. \code{efficientPortfolio} or
 
42
        \code{portfolioFrontier}.
 
43
        }
 
44
    \item{labels}{
 
45
        a logical flag, determining if the the graph should be labeled
 
46
        automatically, which is the default case \code{labels=TRUE}. If 
 
47
        set to \code{FALSE} then the graph will be displayed
 
48
        undecorated and the user can it decorate by himself.
 
49
        }
 
50
    \item{col}{
 
51
        a character string vector, defined from a color palette. The 
 
52
        default setting uses the "Blues" \code{seqPalette} palette.
 
53
        }
 
54
    \item{title}{
 
55
        a logical flag. Should automatically a title and axis labels be
 
56
        added to the plot. 
 
57
        }
 
58
    \item{box}{
 
59
        a logical flag, determining whether a boxed frame should be plotted
 
60
        around the pie, by default the value is set to \code{TRUE}.
 
61
        }
 
62
    \item{legend}{
 
63
        a logical value, determining if the the graph should be labeled
 
64
        automatically, shich is the default case \code{labels=TRUE}. If 
 
65
        set to \code{FALSE} then the graph will be displayed
 
66
        undecorated and the user can it decorate by himself. 
 
67
        Evenmore, if \code{labels} takes the value of a string vector, 
 
68
        then the names of the assets from the porftolio \code{object} 
 
69
        will be ignored, and the labels will be taken from the specified 
 
70
        string vector.
 
71
        }
 
72
    \item{\dots}{
 
73
        additional arguments passed to the function \code{barplot}. Only 
 
74
        active if \code{labels=FALSE}. 
 
75
        }
 
76
    
 
77
 
 
78
}
 
79
 
 
80
 
 
81
\details{
 
82
 
 
83
    These line plots allow for different views on the results obtained
 
84
    from a feasible or an optimized portfolio.
 
85
    
 
86
    The function \code{weightsPlot} displays the weights composition
 
87
    along the frontier of a portfolio. 
 
88
    
 
89
    The function \code{weightedReturnsPlot} displays the investment
 
90
    composition, i.e. the weighted returns along the frontier of a portfolio. 
 
91
    
 
92
    The function \code{covRiskBudgetsPlot} displays the covariance risk
 
93
    budgets composition along the frontier of a portfolio.
 
94
 
 
95
    % NYI
 
96
    %The function \code{tailRiskBudgetsPlot} displays the copulae tail
 
97
    %risk budgets composition along the frontier of a portfolio. Note, 
 
98
    %this is only possible if in the portfolio specification a copulae 
 
99
    %tail risk is defined.
 
100
 
 
101
}
 
102
 
 
103
 
 
104
\note{
 
105
 
 
106
    With Rmetrics Version 2.7 the name of \code{attributesPlot} has been
 
107
    changed to \code{weightedReturnsPlot} since it better describes what
 
108
    the plot shows.
 
109
    
 
110
    The axes labeling has been changed in all plots, now the return on the
 
111
    bottom side, and the risk on the upper side, before it was just vice
 
112
    versa.
 
113
    
 
114
}
 
115
 
 
116
 
 
117
%\references{}
 
118
 
 
119
 
 
120
\seealso{
 
121
 
 
122
    \code{\link{weightsPie}}, 
 
123
    \code{\link{weightsSlider}}.
 
124
    
 
125
}
 
126
 
 
127
 
 
128
\examples{
 
129
## data -
 
130
   # Load Data:
 
131
   Data = as.timeSeries(data(smallcap.ts))
 
132
   Data = Data[, c("BKE", "GG", "GYMB", "KRON")]
 
133
 
 
134
## portfolioFrontier -
 
135
   # Compute Long Only Efficient Frontier
 
136
   frontier = portfolioFrontier(Data)
 
137
   
 
138
## weightsLinePlot -
 
139
   # View Weights Line Plot:
 
140
   # weightsLinePlot(frontier)
 
141
}
 
142
 
 
143
 
 
144
\keyword{models}
 
145