% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rd-to-list.R
\name{rd_to_list}
\alias{rd_to_list}
\title{Converts a given 'Rd' file into a list object}
\usage{
rd_to_list(rd_file, project = ".", pkg = NULL)
}
\arguments{
\item{rd_file}{The name of the source Rd file}

\item{project}{The path to the root folder of the project.}

\item{pkg}{The path inside the project folder. Use only if the R package
itself is in a sub-folder within the project.}
}
\value{
A list object that contains the contents of the Rd file
}
\description{
This function is meant to be used as an intermediate object
that could be used as an easy way to convert the information inside the 'Rd'
into other formats or outputs.
}
\examples{
\dontrun{
library(pkgsite)
rd_to_list("rd_to_list.Rd", project = ".")
}
}
\seealso{
Other Conversion functions:
\code{\link[=index_to_qmd]{index_to_qmd()}},
\code{\link[=rd_to_qmd]{rd_to_qmd()}}
}
\concept{Conversion functions}
