← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/getSpec.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/getSpec.Rd
 
1
\name{getSpec}
 
2
 
 
3
 
 
4
%%\alias{getSpec} %%conflicts with getDefault
 
5
 
 
6
\alias{getModel.fPFOLIOSPEC}
 
7
\alias{getType.fPFOLIOSPEC}  
 
8
\alias{getOptimize.fPFOLIOSPEC}        
 
9
\alias{getEstimator.fPFOLIOSPEC} 
 
10
\alias{getTailRisk.fPFOLIOSPEC}      
 
11
\alias{getParams.fPFOLIOSPEC} 
 
12
\alias{getAlpha.fPFOLIOSPEC}       
 
13
 
 
14
\alias{getPortfolio.fPFOLIOSPEC}        
 
15
\alias{getWeights.fPFOLIOSPEC}         
 
16
\alias{getTargetReturn.fPFOLIOSPEC}    
 
17
\alias{getTargetRisk.fPFOLIOSPEC}       
 
18
\alias{getRiskFreeRate.fPFOLIOSPEC}    
 
19
\alias{getNFrontierPoints.fPFOLIOSPEC} 
 
20
\alias{getStatus.fPFOLIOSPEC}
 
21
 
 
22
\alias{getOptim.fPFOLIOSPEC}
 
23
\alias{getSolver.fPFOLIOSPEC}   
 
24
\alias{getObjective.fPFOLIOSPEC}      
 
25
\alias{getTrace.fPFOLIOSPEC}           
 
26
 
 
27
 
 
28
\title{Portfolio Specification Extractors}
 
29
 
 
30
 
 
31
\description{
 
32
  
 
33
    A collection and description of functions 
 
34
    allowing to get information about an object
 
35
    of class fPFOLIOSPEC. 
 
36
    \cr
 
37
    
 
38
    The functions are:
 
39
    
 
40
    \tabular{ll}{
 
41
    \code{getType} \tab Extracts portfolio type from specification, \cr
 
42
    \code{getOptimize} \tab Extracts what to optimize from specification, \cr
 
43
    \code{getEstimator} \tab Extracts type of covariance estimator, \cr
 
44
    \code{getTailRisk} \tab Extracts list of tail dependency risk matrixes, \cr
 
45
    \code{getParams} \tab Extracts parameters from specification, \cr
 
46
    \code{getWeights} \tab Extracts weights from a portfolio object, \cr
 
47
    \code{getTargetReturn} \tab Extracts target return from specification, \cr
 
48
    \code{getTargetRisk} \tab Extracts target riks from specification, \cr
 
49
    \code{getAlpha} \tab Extracts target VaR-alpha specification, \cr
 
50
    \code{getRiskFreeRate} \tab Extracts risk free rate from specification, \cr
 
51
    \code{getNFrontierPoints} \tab Extracts number of frontier points, \cr 
 
52
    \code{getStatus} \tab Extracts the status of optimization, \cr 
 
53
    \code{getSolver} \tab Extracts solver from specification, \cr
 
54
    \code{getobjective} \tab Extracts name of objective function, \cr
 
55
    \code{getTrace} \tab Extracts solver's trace flag. }
 
56
    
 
57
}
 
58
    
 
59
 
 
60
\usage{
 
61
\method{getModel}{fPFOLIOSPEC}(object)
 
62
\method{getType}{fPFOLIOSPEC}(object)
 
63
\method{getOptimize}{fPFOLIOSPEC}(object)
 
64
\method{getEstimator}{fPFOLIOSPEC}(object)
 
65
\method{getTailRisk}{fPFOLIOSPEC}(object)
 
66
\method{getParams}{fPFOLIOSPEC}(object)
 
67
 
 
68
\method{getPortfolio}{fPFOLIOSPEC}(object)
 
69
\method{getWeights}{fPFOLIOSPEC}(object)
 
70
\method{getTargetReturn}{fPFOLIOSPEC}(object)
 
71
\method{getTargetRisk}{fPFOLIOSPEC}(object)
 
72
\method{getAlpha}{fPFOLIOSPEC}(object)
 
73
\method{getRiskFreeRate}{fPFOLIOSPEC}(object)
 
74
\method{getNFrontierPoints}{fPFOLIOSPEC}(object)
 
75
\method{getStatus}{fPFOLIOSPEC}(object)
 
76
 
 
77
\method{getOptim}{fPFOLIOSPEC}(object)
 
78
\method{getSolver}{fPFOLIOSPEC}(object)
 
79
\method{getObjective}{fPFOLIOSPEC}(object)
 
80
\method{getTrace}{fPFOLIOSPEC}(object)
 
81
}
 
82
 
 
83
 
 
84
\arguments{
 
85
 
 
86
    \item{object}{
 
87
        an object of class \code{fPFOLIOSPEC}.
 
88
        }
 
89
 
 
90
}
 
91
 
 
92
 
 
93
%\references{}
 
94
 
 
95
 
 
96
\examples{
 
97
## get -
 
98
   
 
99
   # Create default specification structure:
 
100
   Spec = portfolioSpec()
 
101
   
 
102
   # Get:
 
103
   getModel(Spec)
 
104
   getType(Spec)
 
105
   getRiskFreeRate(Spec)  
 
106
   getPortfolio(Spec)
 
107
}
 
108
 
 
109
 
 
110
\keyword{models}
 
111