find_layout: Find common files on Box from R with a run ID.

Description Usage Arguments Details Value Examples

Description

Uses boxr::box_search() to find the Box IDs for a run of interest.

Usage

1
2
3
4
5
6
7

Arguments

run

Character. A HemoShear study id like 'BGA0502-5'

Details

The return value is intened for a read-in function like boxr::box_read() or assayr2::device_reader() directly. These

The Box.com search index does not populate instantly when a new file is uploaded, so recently added (~10-15 minutes) files may not be found by these functions.

Value

Numeric, the Box file ID named with the run argument.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
## Not run: 
## Requires BoxR credentials
library(boxr)
library(magrittr)

box_auth()

find_layout("HEM0401-2")
  
find_nucs("PAH0363-2")

# this is deprecated in favor of `find_layout()`
device_finder("HEM0303-7")

# this is deprecated in favor ot `find_nucs()`
nuc_finder("PAH0362-3")

## End(Not run)

hemoshear/assayr2 documentation built on Nov. 8, 2019, 6:13 p.m.