forked from Al-Murphy/MungeSumstats
-
Notifications
You must be signed in to change notification settings - Fork 0
/
check_save_path.Rd
46 lines (41 loc) · 1.52 KB
/
check_save_path.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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/check_save_path.R
\name{check_save_path}
\alias{check_save_path}
\title{Check if save path and log folder is appropriate}
\usage{
check_save_path(
save_path,
log_folder,
log_folder_ind,
tabix_index,
write_vcf = FALSE,
verbose = TRUE
)
}
\arguments{
\item{save_path}{File path to save formatted data. Defaults to
\code{tempfile(fileext=".tsv.gz")}.}
\item{log_folder}{Filepath to the directory for the log files and the log of
MungeSumstats messages to be stored. Default is a temporary directory. Note
the name of the log files (log messages and log outputs) are now the same as
the name of the file specified in the save path parameter with the extension
'_log_msg.txt' and '_log_output.txt' respectively.}
\item{log_folder_ind}{Binary Should log files be stored containing all
filtered out SNPs (separate file per filter). The data is outputted in the
same format specified for the resulting sumstats file. The only exception to
this rule is if output is vcf, then log file saved as .tsv.gz. Default is
FALSE.}
\item{tabix_index}{Index the formatted summary statistics with
\href{http://www.htslib.org/doc/tabix.html}{tabix} for fast querying.}
\item{write_vcf}{Whether to write as VCF (TRUE) or tabular file (FALSE).}
\item{verbose}{Print messages.}
}
\value{
Corrected \code{save_path}, the file type, the separator, corrected
\code{log_folder},the log file extension.
}
\description{
Check if save path and log folder is appropriate
}
\keyword{internal}