<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>predict regression responses from a glm object — glmPredictDS.as • dsBase</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/simplex/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="predict regression responses from a glm object — glmPredictDS.as"><meta property="og:description" content="create a predict_glm object on the serverside by applying
the equivalent of predict.glm() in native R to a glm object on the serverside.
Identify and return components of the predict_glm object 
that can safely be sent to the clientside without a risk of disclosure"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">dsBase</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">6.3.0</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"><li>
  <a href="../reference/index.html">Reference</a>
</li>
      </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>predict regression responses from a glm object</h1>
    
    <div class="hidden name"><code>glmPredictDS.as.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>create a predict_glm object on the serverside by applying
the equivalent of predict.glm() in native R to a glm object on the serverside.
Identify and return components of the predict_glm object 
that can safely be sent to the clientside without a risk of disclosure</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">glmPredictDS.as</span><span class="op">(</span>
  <span class="va">glmname.transmit</span>,
  <span class="va">newdataname.transmit</span>,
  <span class="va">output.type</span>,
  <span class="va">se.fit</span>,
  <span class="va">dispersion</span>,
  <span class="va">terms.transmit</span>,
  <span class="va">na.action</span>
<span class="op">)</span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>glmname.transmit</dt>
<dd><p>a character string specifying the name of the
glm object on the serverside that is to be used for prediction.
Fully specified by glmname argument in ds.glmPredict</p></dd>


<dt>newdataname.transmit</dt>
<dd><p>a character string specifying an (optional) dataframe on
the serverside in which to look for (potentially) new covariate values
on which to base the predictions. Fully specified by newdataname argument in ds.glmPredict.</p></dd>


<dt>output.type</dt>
<dd><p>a character string taking the values 'response', 'link' or 'terms'.
Fully specified by corresponding argument in ds.glmPredict.</p></dd>


<dt>se.fit</dt>
<dd><p>logical if standard errors for the fitted predictions are required.
Fully specified by corresponding argument in ds.glmPredict.</p></dd>


<dt>dispersion</dt>
<dd><p>numeric value specifying the dispersion of the GLM fit to be assumed
in computing the standard errors. Fully specified by corresponding argument in ds.glmPredict.</p></dd>


<dt>terms.transmit</dt>
<dd><p>a character vector specifying a subset of terms to return in the
prediction. Fully specified by 'terms' argument in ds.glmPredict.</p></dd>


<dt>na.action</dt>
<dd><p>character string determining what should be done with missing
values in the data.frame identified by &lt;newdataname.transmit&gt;.
Fully specified by na.action argument in ds.glmPredict.</p></dd>

</dl></div>
    <div id="value">
    <h2>Value</h2>
    

<p>glmPredict.as writes a new object to the serverside containing
output precisely equivalent to the output from predict.glm in native R.
For more details see DataSHIELD help for ds.glmPredict and help for
predict.glm in native R</p>
    </div>
    <div id="details">
    <h2>Details</h2>
    <p>Serverside assign function called by ds.glmPredict
makes predictions of regression responses based on a serverside glm object
that has already been created on the serverside by ds.glmSLMA and
and writes the predict_glm object to the serverside.
For further details see help for ds.glmPredict and help in native R
for predict.glm</p>
    </div>
    <div id="author">
    <h2>Author</h2>
    <p>Paul Burton for DataSHIELD Development Team (20/7/20)</p>
    </div>

  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
    </nav></div>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by DataSHIELD Developers.</p>
</div>

<div class="pkgdown">
  <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>

      </footer></div>

  


  

  </body></html>

