Package 'neurocInstall'

Title: 'Neuroconductor' Installer
Description: Installs 'Neuroconductor' packages from the release repository <https://neuroconductor.org/releases/> or from 'GitHub'.
Authors: John Muschelli <[email protected]>
Maintainer: John Muschelli <[email protected]>
License: GPL-2
Version: 0.12.2
Built: 2024-11-05 05:17:15 UTC
Source: https://github.com/muschellij2/neurocinstall

Help Index


Latest Neuroconductor Release Location

Description

Latest Neuroconductor Release Location

Usage

latest_neuroc_release(secure = TRUE)

binary_release_repo(release = c("stable", "current"), secure = TRUE)

make_release_version(release_path = NULL, secure = TRUE, check = TRUE)

release_versions(secure = TRUE)

Arguments

secure

Should https vs. http be used

release

Stable or current (development) versions

release_path

path to the release on https://neuroconductor.org/releases/

check

should the 'release_path' need to be checked against all the releases?

Value

URL of release page

Examples

make_release_version("2018/02/", check = FALSE)

latest_neuroc_release()

Make Full Package Version

Description

Makes a package version to have all the same length. This is helpful when using compareVersion.

Usage

make_full_version(x)

Arguments

x

Character vector of package versions

Value

Character vector of versions, each with the same length.

Examples

x = c("1.6", "1.6.0")
compareVersion(x[1], x[2])
x2 = make_full_version(x)
compareVersion(x2[1], x2[2])
x = c("1.6", "1.6.0")
compareVersion(x2[1], x2[2])

Neuroconductor Installer

Description

Install function for neuroconductor packages

Usage

neuro_install(
  repo,
  release = c("stable", "current"),
  release_repo = latest_neuroc_release(),
  upgrade_dependencies = FALSE,
  type = getOption("pkgType"),
  ...
)

neuroc_install(...)

neurocLite(...)

Arguments

repo

Package name in neuroconductor

release

Stable or current (development) versions/branches

release_repo

Repository for release repository, passed to install.packages. If release_repo = "github", then it will install using GitHub. If you set this using make_release_version or specify the URL directly, it will override release option.

upgrade_dependencies

Should dependencies be updated? passed to install if using release_repo = "github"

type

character, indicating the type of package to download and install, passed to install.packages.

...

additional arguments passed to install.packages or install_github if release_repo = "github"

Value

Result from install.packages or install_github

Examples

tlib = tempfile()
   dir.create(tlib, showWarnings = FALSE)
   system.time({
   install.packages("oro.asl",
   lib = tlib,
   repos = "https://neuroconductor.org/releases/2019/12/",
   verbose = TRUE)
   })
   repos = getOption("repos")
   print(repos)
   #if (repos["CRAN"] == "@CRAN@") {
   #    repos["CRAN"] = "https://cloud.r-project.org"
   #    options(repos = repos)
   #}
   options(repos = NULL)
   print(getOption("repos"))
   neuro_install("oro.asl", lib = tlib,
   release_repo = "https://neuroconductor.org/releases/2019/12")
   options(repos = repos)
 

   options(repos = "http://cran.r-project.org")
   neuro_install("cifti", type = "source", lib = tlib, verbose = TRUE)
   neuro_install("cifti",
   release_repo = latest_neuroc_release(),
   lib = tlib)

   neuro_install("cifti", release_repo = "github")

Neuroconductor Package Table

Description

Returns the table of Neuroconductor packages

Usage

neuro_package_table(
  path = "https://neuroconductor.org/neurocPackages",
  long = FALSE,
  deployment = FALSE
)

Arguments

path

Path to the table of package

long

Should the data be "long" (with respect to stable/current)

deployment

indicator if this is a release, not standard flag.

Value

data.frame of packages with commit IDs

Note

Package information is obtained from https://neuroconductor.org/neurocPackages

Examples

neuro_package_table()

Neuroconductor Packages

Description

Returns the vector of Neuroconductor packages

Usage

neuro_packages(...)

Arguments

...

Arguments passed to neuro_package_table

Value

vector of packages available on Neuroconductor

Examples

neuro_packages()