Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • ccd3e00
  • /
  • man
  • /
  • gsm.control.Rd
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:50bad6e43edecc247fa1c03ee02e2cda60f5459d
directory badge
swh:1:dir:c46e75d384ee99dc386fd00dec564cd5a0ca3e73

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
gsm.control.Rd
\name{gsm.control}
\alias{gsm.control}
\title{
Defaults for the gsm call
}
\description{
Set useful default and allow changes for the gsm call. This is meant to
make the gsm call simpler.
}
\usage{
gsm.control(parscale = 1, maxit = 300, optimiser = c("BFGS", "NelderMead"), trace = 0,
            nodes = 9, adaptive = TRUE, kappa.init = 1, maxkappa = 1000,
            suppressWarnings.coxph.frailty = TRUE, robust_initial = FALSE, bhazinit = 0.1,
            eps.init = 1e-5, use.gr = TRUE, penalty = c("logH", "h"), outer_optim = 1,
            reltol.search = 1e-10, reltol.final = 1e-10, reltol.outer = 1e-05,
            criterion = c("GCV", "BIC"))
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{parscale}{
numeric vector or scalar for the scaling of the parameter values;
default 1
}
  \item{maxit}{
integer for the maximum number of iterations for the optimisation process
}
  \item{optimiser}{
which optimiser to use for the outer optimisation
}
  \item{trace}{
integer indicating the trace level for each optimiser
}
  \item{nodes}{
number of quadrature nodes
}
  \item{adaptive}{
logical for whether to use adaptive or non-adaptive
  quadrature, Default=TRUE. 
}
  \item{kappa.init}{
initial value for the quadratic penalty for inequality constraints
}
  \item{eps.init}{
initial value for epsilon
}
  \item{maxkappa}{
double float value for the maximum value of the weight
  used in the constraint.
}
  \item{suppressWarnings.coxph.frailty}{
logical
}
  \item{robust_initial}{
Not currently documented.
}
  \item{bhazinit}{
Not currently documented.
}
  \item{use.gr}{
Logical for whether to use gradients.
}
  \item{penalty}{
Not currently documented.
}
  \item{outer_optim}{
Not currently documented.
}
  \item{reltol.search}{
Relative tolerance. Not currently documented.
}
  \item{reltol.final}{
Relative tolerance. Not currently documented.
}
  \item{reltol.outer}{
Relative tolerance. Not currently documented.
}
  \item{criterion}{
Not currently documented.
}
}
%% \details{
%% }
%% \value{
%% %%  ~Describe the value returned
%% %%  If it is a LIST, use
%% %%  \item{comp1 }{Description of 'comp1'}
%% %%  \item{comp2 }{Description of 'comp2'}
%% %% ...
%% }
%% \references{
%% %% ~put references to the literature/web site here ~
%% }
%% \author{
%% %%  ~~who you are~~
%% }
%% \note{
%% %%  ~~further notes~~
%% }

%% ~Make other sections like Warning with \section{Warning }{....} ~

%% \seealso{
%% %% ~~objects to See Also as \code{\link{help}}, ~~~
%% }
%% \examples{
%% }
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
%% \keyword{ ~kwd1 }% use one of  RShowDoc("KEYWORDS")
%% \keyword{ ~kwd2 }% __ONLY ONE__ keyword per line

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API