GitLab at IIASA

Skip to content
GitLab
Find file Normal view History Permalink
groupstats.html 12.7 KiB
Newer Older
Hugo Scherer's avatar
Improved FarmDynR package and added new capability
Hugo Scherer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 
<!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>Generate descriptive statistics and save to GDX — groupstats • FarmDynR</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 rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" 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="Generate descriptive statistics and save to GDX — groupstats"><meta property="og:description" content="`groupstats()` returns descriptive statistics per group based on the mapping given. For example, if your mapping
is 'regions', this function will give you the weighted mean, median, min, max, number of observations per variable for each
region based on the individual farm data. When `writegdx` is `TRUE`, it writes the GDX in the format 'farmStats_(mapping).gdx'
`groupstats()` returns descriptive statistics per group based on the mapping given. For example, if your mapping
is 'regions', this function will give you the weighted mean, median, min, max, number of observations per variable for each
region based on the individual farm data. When `writegdx` is `TRUE`, it writes the GDX in the format 'farmStats_(mapping).gdx'"><!-- 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">FarmDynR</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.2.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>
<li>
  <a href="../news/index.html">Changelog</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>Generate descriptive statistics and save to GDX</h1>
    
    <div class="hidden name"><code>groupstats.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>`groupstats()` returns descriptive statistics per group based on the mapping given. For example, if your mapping
is 'regions', this function will give you the weighted mean, median, min, max, number of observations per variable for each
region based on the individual farm data. When `writegdx` is `TRUE`, it writes the GDX in the format 'farmStats_(mapping).gdx'</p>
<p>`groupstats()` returns descriptive statistics per group based on the mapping given. For example, if your mapping
is 'regions', this function will give you the weighted mean, median, min, max, number of observations per variable for each
region based on the individual farm data. When `writegdx` is `TRUE`, it writes the GDX in the format 'farmStats_(mapping).gdx'</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">groupstats</span><span class="op">(</span></span>
<span>  <span class="va">filename</span>,</span>
<span>  <span class="va">BINDir</span>,</span>
<span>  <span class="va">gdxmap</span>,</span>
<span>  <span class="va">mapping</span>,</span>
<span>  <span class="va">cols</span>,</span>
<span>  <span class="va">w</span>,</span>
<span>  writegdx <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  filtern <span class="op">=</span> <span class="cn">FALSE</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">groupstats</span><span class="op">(</span></span>
<span>  <span class="va">filename</span>,</span>
<span>  <span class="va">BINDir</span>,</span>
<span>  <span class="va">gdxmap</span>,</span>
<span>  <span class="va">mapping</span>,</span>
<span>  <span class="va">cols</span>,</span>
<span>  <span class="va">w</span>,</span>
<span>  writegdx <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  filtern <span class="op">=</span> <span class="cn">FALSE</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>filename</dt>
<dd><p>Name of the GDX file with BIN data and mappings.</p></dd>


<dt>BINDir</dt>
<dd><p>Directory where the FADN data is located.</p></dd>


<dt>gdxmap</dt>
<dd><p>Name of the set in the GDX file that contains the mapping (e.g. Regs2BINID)</p></dd>


<dt>mapping</dt>
<dd><p>Column name of the characteristic/variable to be grouped by (e.g. "Regions" or "Regs")</p></dd>


<dt>cols</dt>
<dd><p>Which columns to derive descriptive statistics from</p></dd>


<dt>w</dt>
<dd><p>Column with the Weights for the weighted mean</p></dd>


<dt>writegdx</dt>
<dd><p>Logical. If `TRUE`, it writes a GDX with the descriptive statistics.</p></dd>


<dt>filtern</dt>
<dd><p>Logical. If `TRUE`, results will be limited to more than 15 observations per variable for reporting</p></dd>

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

<p>A tibble `tbl_df`.</p>


<p>A tibble `tbl_df`.</p>
    </div>
    <div id="see-also">
    <h2>See also</h2>
    <div class="dont-index">
<ul><li><p><code>summary]</code>summary statistics</p></li>
<li><p><code><a href="https://rdrr.io/pkg/psych/man/describe.html" class="external-link">describe</a></code>Descriptive statistics</p></li>
<li><p><code><a href="https://rdrr.io/pkg/gdxrrw/man/wgdx.html" class="external-link">wgdx</a></code>Write R data to GDX</p></li>
<li><p><code><a href="https://rdrr.io/pkg/gdxrrw/man/wgdx.html" class="external-link">wgdx.lst</a></code>Write multiple symbols to GDX</p></li>
<li><p><code><a href="https://tidyr.tidyverse.org/reference/pivot_longer.html" class="external-link">pivot_longer</a></code>Make dataframes longer</p></li>
</ul><ul><li><p><code>summary]</code>summary statistics</p></li>
<li><p><code><a href="https://rdrr.io/pkg/psych/man/describe.html" class="external-link">describe</a></code>Descriptive statistics</p></li>
<li><p><code><a href="https://rdrr.io/pkg/gdxrrw/man/wgdx.html" class="external-link">wgdx</a></code>Write R data to GDX</p></li>
<li><p><code><a href="https://rdrr.io/pkg/gdxrrw/man/wgdx.html" class="external-link">wgdx.lst</a></code>Write multiple symbols to GDX</p></li>
<li><p><code><a href="https://tidyr.tidyverse.org/reference/pivot_longer.html" class="external-link">pivot_longer</a></code>Make dataframes longer</p></li>
</ul></div>
    </div>

    <div id="ref-examples">
    <h2>Examples</h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">BINDir</span> <span class="op">&lt;-</span> <span class="st">"inst/extdata/GAMS"</span></span></span>
<span class="r-in"><span><span class="va">datafile</span> <span class="op">&lt;-</span> <span class="st">'FarmDynRexampledata.gdx'</span></span></span>
<span class="r-in"><span><span class="fu">groupstats</span><span class="op">(</span><span class="st">'FarmDynRexampledata.gdx'</span>,</span></span>
<span class="r-in"><span>            BINDir<span class="op">=</span><span class="st">"inst/extdata/GAMS/"</span>,</span></span>
<span class="r-in"><span>            gdxmap <span class="op">=</span> <span class="st">'map2binid'</span>,</span></span>
<span class="r-in"><span>            mapping <span class="op">=</span> <span class="st">'mapping'</span>,</span></span>
<span class="r-in"><span>            cols <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'a'</span>, <span class="st">'b'</span><span class="op">)</span>,</span></span>
<span class="r-in"><span>            w<span class="op">=</span><span class="st">'Weight'</span><span class="op">)</span></span></span>
<span class="r-err co"><span class="r-pr">#&gt;</span> <span class="error">Error in rgdx(gdxName, list(name = symName, compress = compress, ts = ts),     squeeze = squeeze, useDomInfo = useDomInfo):</span> GDX file 'inst/extdata/GAMS//FarmDynRexampledata.gdx' not found</span>
<span class="r-in"><span><span class="va">BINDir</span> <span class="op">&lt;-</span> <span class="st">"inst/extdata/GAMS"</span></span></span>
<span class="r-in"><span><span class="va">datafile</span> <span class="op">&lt;-</span> <span class="st">'FarmDynRexampledata.gdx'</span></span></span>
<span class="r-in"><span><span class="fu">groupstats</span><span class="op">(</span><span class="st">'FarmDynRexampledata.gdx'</span>,</span></span>
<span class="r-in"><span>            BINDir<span class="op">=</span><span class="st">"inst/extdata/GAMS/"</span>,</span></span>
<span class="r-in"><span>            gdxmap <span class="op">=</span> <span class="st">'map2binid'</span>,</span></span>
<span class="r-in"><span>            mapping <span class="op">=</span> <span class="st">'mapping'</span>,</span></span>
<span class="r-in"><span>            cols <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'a'</span>, <span class="st">'b'</span><span class="op">)</span>,</span></span>
<span class="r-in"><span>            w<span class="op">=</span><span class="st">'Weight'</span><span class="op">)</span></span></span>
<span class="r-err co"><span class="r-pr">#&gt;</span> <span class="error">Error in rgdx(gdxName, list(name = symName, compress = compress, ts = ts),     squeeze = squeeze, useDomInfo = useDomInfo):</span> GDX file 'inst/extdata/GAMS//FarmDynRexampledata.gdx' not found</span>
</code></pre></div>
    </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 Hugo Scherer.</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>

GitLab at IIASA