feat: tiny update for CRAN submission

DESCRIPTION

@@ -6,7 +6,7 @@ Authors@R: c(
     person("Katharina", "Meiszl", , "meiszl@amib.rub-uni-bochum.de", role = c("aut"))
     )
 Maintainer: Robin Denz <robin.denz@rub.de>
-Description: Simulate complex data from a given DAG and information about each individual node.
+Description: Simulate complex data from a given directed acyclic graph and information about each individual node.
 	Root nodes are simply sampled from the specified distribution. Child Nodes are simulated according to
 	one of many implemented regressions, such as logistic regression, linear
 	regression, poisson regression and more. Also includes a comprehensive framework for discrete-time

codemeta.json

@@ -2,7 +2,7 @@
   "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
   "@type": "SoftwareSourceCode",
   "identifier": "simDAG",
-  "description": "Simulate complex data from a given DAG and information about each individual node. Root nodes are simply sampled from the specified distribution. Child Nodes are simulated according to one of many implemented regressions, such as logistic regression, linear regression, poisson regression and more. Also includes a comprehensive framework for discrete-time simulation, which can generate even more complex longitudinal data.",
+  "description": "Simulate complex data from a given directed acyclic graph and information about each individual node. Root nodes are simply sampled from the specified distribution. Child Nodes are simulated according to one of many implemented regressions, such as logistic regression, linear regression, poisson regression and more. Also includes a comprehensive framework for discrete-time simulation, which can generate even more complex longitudinal data.",
   "name": "simDAG: Simulate Data from a DAG and Associated Node Information",
   "relatedLink": "https://robindenz1.github.io/simDAG/",
   "codeRepository": "https://github.com/RobinDenz1/simDAG",
@@ -200,7 +200,7 @@
     },
     "SystemRequirements": null
   },
-  "fileSize": "924.053KB",
+  "fileSize": "924.187KB",
   "citation": [
     {
       "@type": "CreativeWork",
@@ -220,5 +220,9 @@
       "name": "simDAG: An R Package to Simulate Simple and Complex (Longitudinal) Data from a DAG and Associated Node Information",
       "url": "https://github.com/RobinDenz1/simDAG"
     }
-  ]
+  ],
+  "releaseNotes": "https://github.com/RobinDenz1/simDAG/blob/master/NEWS.md",
+  "readme": "https://github.com/RobinDenz1/simDAG/blob/main/README.md",
+  "contIntegration": ["https://github.com/RobinDenz1/simDAG/actions/workflows/R-CMD-check.yaml", "https://app.codecov.io/gh/RobinDenz1/simDAG?branch=main"],
+  "developmentStatus": "https://www.repostatus.org/#active"
 }

cran-comments.md

@@ -5,4 +5,4 @@
 * This is the first release of this package
 
 The package was tested on Windows 10, macOS and ubuntu using github actions and rhub as well as local machines.
-There were no errors or warnings and no notes.
+There were no errors or warnings and no notes. There is currently no literature directly associated with this package.

man/node_time_to_event.Rd

@@ -35,13 +35,13 @@ A function that returns a numeric vector of size \code{nrow(data)} containing on
 An arbitrary amount of additional named arguments passed to \code{prob_fun}. Ignore this if you do not want to pass any arguments. Also ignored if \code{prob_fun} is a single number.
   }
   \item{event_duration}{
-A single number >= 0 specifying how long the event should last.
+A single number >= 0 specifying how long the event should last. The point in time at which an event occurs also counts into this duration. For example, if an event occurs at \eqn{t = 2} and it has a duration of 3, the event will be set to \code{TRUE} on \eqn{t \in \{2, 3, 4\}}.
   }
   \item{immunity_duration}{
 A single number >= \code{event_duration} specifying how long the person should be immune to the event after it is over. The count internally starts when the event starts, so in order to use an immunity duration of 10 time units after the event is over \code{event_duration + 10} should be used.
   }
   \item{time_since_last}{
-Either \code{TRUE} or \code{FALSE} (default), indicating whether an additional column should be generated that tracks the number of time units since the individual had its last event onset. For example, if the individual experienced a single event at t = 10, this column would be \code{NA} before time 10, 0 at time 10 and increased by 1 at each point in time. If another event happens, the time is set to 0 again. The column is named \code{paste0(name, "_time_since_last")}. The difference to the column ending with \code{"_time"} is that this column will not be set to \code{NA} again if the \code{immunity_duration} is over. It keeps counting until the end of the simulation, which may be useful when constructing event-time dependent probability functions.
+Either \code{TRUE} or \code{FALSE} (default), indicating whether an additional column should be generated that tracks the number of time units since the individual had its last event onset. For example, if the individual experienced a single event at \eqn{t = 10}, this column would be \code{NA} before time 10, 0 at time 10 and increased by 1 at each point in time. If another event happens, the time is set to 0 again. The column is named \code{paste0(name, "_time_since_last")}. The difference to the column ending with \code{"_time"} is that this column will not be set to \code{NA} again if the \code{immunity_duration} is over. It keeps counting until the end of the simulation, which may be useful when constructing event-time dependent probability functions.
   }
   \item{event_count}{
 Either \code{TRUE} or \code{FALSE} (default), indicating whether an additional column should be generated that tracks the number of events the individual has already experienced. This column is 0 for all individuals at t = 0. Each time a new event occurs, the counter is increased by one. Note that only new events increase this counter. For example, an individual with an event at t = 10 that has an \code{event_duration} of 15 will have a value of 0 before t = 10, and will have a value of 1 at t = 10 and afterwards. The column will be named \code{paste0(name, "_event_count")}.

man/plot.DAG.Rd

@@ -24,7 +24,7 @@ Using the node information contained in the \code{DAG} object this function plot
 }
 \arguments{
   \item{x}{
-A \code{DAG} object created using the \code{\link{empty_dag}} function with nodes added to it using the \code{+} syntax. See \code{\link{empty_dag}} or \code{\link{node}} for more details. Currently does not support DAGs with time-dependent nodes added using the \code{\link{node_td}} function.
+A \code{DAG} object created using the \code{\link{empty_dag}} function with nodes added to it using the \code{+} syntax. See \code{\link{empty_dag}} or \code{\link{node}} for more details.
   }
   \item{layout}{
 A single character string specifying the layout of the plot. This internally calls the \code{layout_} function of the \pkg{igraph} package, which offers a great variety of ways to layout the nodes of a graph. Defaults to \code{"nicely"}. Some other options are: \code{"as_star"}, \code{"as_tree"}, \code{"in_circle"}, \code{"on_spere"}, \code{"randomly"} and many more. For more details see \code{?layout_}.