-
Notifications
You must be signed in to change notification settings - Fork 13
/
list_data.Rd
84 lines (71 loc) · 2.16 KB
/
list_data.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/list_data.R
\name{list_data}
\alias{list_data}
\title{List available git2rdata files containing data}
\usage{
list_data(root = ".", path = ".", recursive = TRUE)
}
\arguments{
\item{root}{the \code{root} of the repository. Either a path or a \code{git-repository}}
\item{path}{relative \code{path} from the \code{root}. Defaults to the \code{root}}
\item{recursive}{logical. Should the listing recurse into directories?}
}
\value{
a character vector of dataframe names, including their relative path
}
\description{
The selection lists all \code{.tsv} files with a matching \strong{valid} metadata file.
\strong{invalid} metadata files result in a warning.
}
\examples{
## on file system
# create a directory
root <- tempfile("git2rdata-")
dir.create(root)
# store a dataframe
write_vc(iris[1:6, ], "iris", root, sorting = "Sepal.Length")
# list the available data and the files
list_data(root)
list.files(root, recursive = TRUE)
# remove all .tsv files with an associated .yml file
rm_data(root, path = ".")
# check the removal of the data
list.files(root, recursive = TRUE)
list_data(root)
# remove dangling meta data files
prune_meta(root, path = ".")
# check the removal of the meta data
list.files(root, recursive = TRUE)
list_data(root)
## on git repo
# initialise a git repo using git2r
repo_path <- tempfile("git2rdata-repo-")
dir.create(repo_path)
repo <- git2r::init(repo_path)
git2r::config(repo, user.name = "Alice", user.email = "alice@example.org")
# store a dataframe
write_vc(iris[1:6, ], "iris", repo, sorting = "Sepal.Length", stage = TRUE)
# check that the dataframe is stored
status(repo)
list_data(repo)
# commit the current version and check the git repo
commit(repo, "add iris data", session = TRUE)
status(repo)
# remove the data files from the repo
rm_data(repo, path = ".")
# check the removal
list_data(repo)
status(repo)
# remove dangling meta data
prune_meta(repo, path = ".")
# check the removal
list_data(repo)
status(repo)
}
\seealso{
Other storage: \code{\link{prune_meta}},
\code{\link{read_vc}}, \code{\link{relabel}},
\code{\link{rm_data}}, \code{\link{write_vc}}
}
\concept{storage}