← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/portfolioFrontier.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/portfolioFrontier.Rd
 
1
\name{portfolioFrontier}
 
2
 
 
3
 
 
4
\alias{portfolioFrontier}
 
5
 
 
6
 
 
7
\title{Efficient Portfolio Frontier}
 
8
 
 
9
 
 
10
\description{
 
11
  
 
12
    Compoutes the efficient portfolio frontier.
 
13
    
 
14
}
 
15
    
 
16
 
 
17
\usage{
 
18
portfolioFrontier(data, spec = portfolioSpec(), constraints = "LongOnly",
 
19
    include.mvl = TRUE, title = NULL, description = NULL)
 
20
}
 
21
 
 
22
 
 
23
 
 
24
\arguments{
 
25
 
 
26
    \item{constraints}{
 
27
        a character string vector, containing the constraints of the form\cr
 
28
        \code{"minW[asset]=percentage"} for box constraints resp. \cr
 
29
        \code{"maxsumW[assets]=percentage"} for sector constraints.
 
30
        }
 
31
    \item{data}{
 
32
        a multivariate time series described by an S4 object of class
 
33
        \code{timeSeries}. If your timeSerie is not a \code{timeSeries}
 
34
        object, consult the generic function \code{as.timeSeries} to 
 
35
        convert your time series.
 
36
        }
 
37
    \item{description}{ 
 
38
        a character string which allows for a brief description. 
 
39
        }
 
40
    \item{include.mvl}{ 
 
41
        a logical flag, should the minimum variance locus be added to the 
 
42
        plot? 
 
43
        }
 
44
    \item{spec}{
 
45
        an S4 object of class \code{fPFOLIOSPEC} as returned by the function
 
46
        \code{portfolioSpec}.
 
47
        }
 
48
    \item{title}{
 
49
        a character string which allows for a project title.
 
50
        } 
 
51
}
 
52
 
 
53
 
 
54
\details{
 
55
    
 
56
    \bold{Portfolio Frontier:}
 
57
    \cr\cr   
 
58
    
 
59
 
 
60
    The function \code{portfolioFrontier} calculates the whole efficient 
 
61
    frontier. The portfolio information consists of five arguments: data, 
 
62
    specifications, constraints, title and description. 
 
63
    
 
64
    The range of the frontier is determined from the range of the asset
 
65
    returns, and the number of equidistant points in the returns, is
 
66
    calculated from the number of frontier points hold in the specifrication 
 
67
    structure. To extract or to modify the number of frontier points
 
68
    use the functions \code{getNFrontierPoints} and \code{setNFrontierPoints}.
 
69
   
 
70
    
 
71
    The \code{frontierPortfolio} function returns the properties of 
 
72
    the the efficient frontier as an S4 object of class \code{fPORTFOLIO}.
 
73
 
 
74
}
 
75
 
 
76
 
 
77
\value{
 
78
    
 
79
    \code{portfolioFrontier} function returns an S4 object of class 
 
80
    \code{"fPORTFOLIO"}.
 
81
    
 
82
}
 
83
 
 
84
 
 
85
 
 
86
%\references{}
 
87
 
 
88
 
 
89
\examples{
 
90
## portfolioFrontier -
 
91
   
 
92
   # Load Data and Convert to timeSeries Object:
 
93
   Data = as.timeSeries(data(smallcap.ts))
 
94
   Data = Data[, c("BKE", "GG", "GYMB", "KRON")]
 
95
   Data
 
96
   
 
97
   # Set Default Specifications:
 
98
   Spec = portfolioSpec()
 
99
   Spec
 
100
   setNFrontierPoints = 10
 
101
   
 
102
   # Allow for unlimited Short Selling:
 
103
   Constraints = "LongOnly"
 
104
   
 
105
   # Compute 10 points efficient frontier:
 
106
   portfolioFrontier(Data, Spec, Constraints)  
 
107
}
 
108
 
 
109
 
 
110
\keyword{models}
 
111