← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/class-fPFOLIOSPEC.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/class-fPFOLIOSPEC.Rd
 
1
\name{fPFOLIOSPEC-class}
 
2
 
 
3
 
 
4
\alias{fPFOLIOSPEC}
 
5
\alias{class-fPFOLIOSPEC}
 
6
 
 
7
\alias{fPFOLIOSPEC-class}
 
8
 
 
9
\alias{show,fPFOLIOSPEC-method}
 
10
 
 
11
 
 
12
\title{Specification of Portfolios}
 
13
 
 
14
 
 
15
\description{
 
16
  
 
17
    Specifies portfolios.
 
18
    
 
19
}
 
20
 
 
21
 
 
22
\usage{       
 
23
\S4method{show}{fPFOLIOSPEC}(object)
 
24
}
 
25
 
 
26
 
 
27
\arguments{
 
28
 
 
29
    \item{object}{
 
30
        an S4 object of class \code{fPFOLIOSPEC}.
 
31
        }
 
32
 
 
33
}       
 
34
 
 
35
 
 
36
\details{
 
37
 
 
38
    \bold{Portfolio Specifcation Structure:}
 
39
    \cr\cr
 
40
    
 
41
    The S4 class \code{fPFOLIOSPEC} specifies the portfolio. The slots 
 
42
    are:\cr
 
43
    
 
44
    \describe{
 
45
        \item{@call}{
 
46
            a call, returning the matched function call.
 
47
            }
 
48
        \item{@model}{
 
49
            a list, setting the \code{type} of portfolio to be optimized, 
 
50
            and the mean/covariance \code{estimator} to be applied:
 
51
            \cr
 
52
            \code{type=c("MV","CVaR")} a character string denoting the type of
 
53
                portfolio, the implemented types are the
 
54
                Mean-Variance Markowitz Portfolio, \code{"MV"}, and the
 
55
                Mean-CVaR Portfolio, \code{"CVaR"}.
 
56
                \cr
 
57
            \code{estimator=c("mean","cov")} a vector of two character
 
58
                strings, the first denoting the mean estimator, and the 
 
59
                second the covariance estimator. Additional meaningful 
 
60
                selections include robust covariance estimators, e.g. 
 
61
                \code{c("mean","mcd")}, or \code{c("mean","shrink")}.
 
62
                \cr
 
63
            \code{tailRisk=list()} a list of optional tail risk information,
 
64
                currently not used.\cr
 
65
            \code{params=list()} a list of optional model parameters,
 
66
                currently not used.
 
67
            }     
 
68
        \item{@portfolio}{
 
69
            a list, settings portfolio parameters including predefined
 
70
            weights, target return, risk free rate, number of frontier
 
71
            points:
 
72
            \cr 
 
73
            \code{weights=NULL} a numeric vector specifying the portfolio 
 
74
                weights.
 
75
                \cr
 
76
            \code{targetReturn=NULL} a numeric value specifying the target 
 
77
                return. The default value sets the target return.
 
78
                \cr
 
79
            \code{targetRisk=NULL} a numeric value specifying the target 
 
80
                risk.\cr
 
81
            \code{targetAlpha=NULL} a numeric value specifying the target 
 
82
                alpha confidence level for CVaR portfolio optimization. 
 
83
                The default value sets the target return.
 
84
                \cr
 
85
            \code{riskFreeRate=0} a numeric value specifying the risk free 
 
86
                rate.
 
87
                \cr  
 
88
            \code{nFrontierPoints=50} a numeric value determining the number
 
89
                of points on the efficient frontier.
 
90
            }
 
91
        \item{@solver}{
 
92
            a list, setting the type of solver to be used for portfolio
 
93
            optimization:
 
94
            \cr 
 
95
            \code{type=c("quadprog", "Rdonlp2", "lpSolve")} a character
 
96
                string specifying the name of the solver to be used.\cr
 
97
            \code{trace=FALSE} a logical flag, should the optimization be
 
98
                traced?
 
99
            }
 
100
        \item{@title}{
 
101
            a title string, with a default project title. 
 
102
            }
 
103
        \item{@description}{
 
104
            a character string, with a default project description.
 
105
            }
 
106
    }
 
107
 
 
108
}
 
109
 
 
110
 
 
111
\value{
 
112
  
 
113
    \code{portfolioSpec}\cr
 
114
    \cr
 
115
    returns an S4 object of class \code{"fPFOLIOSPEC"}.
 
116
 
 
117
}
 
118
 
 
119
 
 
120
%\references{}
 
121
 
 
122
 
 
123
\examples{
 
124
## portfolioSpec -
 
125
   
 
126
   # Show Default Portfolio Specifications:
 
127
   Spec = portfolioSpec()
 
128
   
 
129
   # Change Risk Free Rate
 
130
   setRiskFreeRate(Spec) = 3
 
131
   Spec
 
132
}
 
133
 
 
134
 
 
135
\keyword{models}
 
136