The metafor Package

A Meta-Analysis Package for R

User Tools

Site Tools


installation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
installation [2019/10/29 09:41] – external edit 127.0.0.1installation [2023/06/21 06:49] (current) Wolfgang Viechtbauer
Line 3: Line 3:
 ==== Installing the Official Release ==== ==== Installing the Official Release ====
  
-You can install the package (or upgrade to the latest official release version) directly within [[http://www.r-project.org/|R]] by typing: <code rsplus>install.packages("metafor")</code> (assuming an internet connection and appropriate access rights on the computer)[[http://www.r-project.org/|R]] will then download the package from [[http://cran.r-project.org/|CRAN]] (the Comprehensive R Archive Networkand automatically install it (or upgrade to the newest version if the package is already installed).+The current official (i.e.[[https://cran.r-project.org/package=metafor|CRAN]]) release can be installed within R with:
  
-You may receive one of several prompts during this process. If you are prompted whether you would like to use a personal library, answer 'Yes'. If you are prompted whether you would like to create a personal library, answer 'Yes'. If you are prompted for choosing a CRAN mirror, just select the top option.+<code rsplus> 
 +install.packages("metafor"
 +</code>
  
-Alternatively, you can download the source files or a Windows or MacOS X binary from [[http://cran.r-project.org/web/packages/metafor/index.html|CRAN]] and install the package manually. See the [[http://cran.r-project.org/manuals.html|R Installation and Administration]] manual for more details on how to install packages this way.+The same command can also be used to upgrade to the newest version if the package is already installed. 
 + 
 +You may receive one of several prompts during this process. If you are prompted whether you would like to use a personal library, answer 'Yes'. If you are prompted to choose a CRAN mirror, just select the first option. 
 + 
 +Alternatively, you can download the source file or a Windows or macOS binary from [[https://cran.r-project.org/package=metafor|CRAN]] and install the package manually. See the [[https://cran.r-project.org/doc/manuals/r-release/R-admin.html#Installing-packages|R Installation and Administration]] manual for more details on how to install packages this way.
  
 ==== Loading the Package ==== ==== Loading the Package ====
  
-Once the package is installed, you can load it with: <code rsplus>library(metafor)</code> For an overview and introduction to the package, just type: <code rsplus>help(metafor)</code> On this website, you can also find some more information on how to obtain further [[help|documentation and help]] when using the package.+Once the package is installed, you can load it with: 
 + 
 +<code rsplus> 
 +library(metafor) 
 +</code> 
 + 
 +For an overview and introduction to the package, just type: 
 + 
 +<code rsplus> 
 +help(metafor) 
 +</code> 
 + 
 +On this website, you can also find more information on how to obtain further [[help|documentation and help]] when using the package.
  
 ==== Development Version ==== ==== Development Version ====
  
-After installing the [[https://cran.r-project.org/package=remotes|remotes]] package with ''install.packages("remotes")'', the development version of the metafor package can be installed with:+The package is continuously being updated and extended with new features. These updates are first part of the development ('devel') version of the package, which is hosted on [[https://github.com/wviechtb/metafor|GitHub]]. If you would like to try out the devel version, it can be installed with: 
 <code rsplus> <code rsplus>
 +install.packages("remotes")
 remotes::install_github("wviechtb/metafor") remotes::install_github("wviechtb/metafor")
 </code> </code>
-This builds the package from source based on the current version on [[https://github.com/wviechtb/metafor|GitHub]].+ 
 +Whenever a sufficient number of updates have accumulated in the devel version, it is submitted to CRAN and becomes the new official release (with a new version number).
  
installation.txt · Last modified: 2023/06/21 06:49 by Wolfgang Viechtbauer