[R-pkg-devel] (no subject)

[Socorro Dominguez]

Thank you!

So, based on this link:
https://r-pkgs.org/description.html#:~:text=to%20be%20indented%3A-,Description,-%3A%20The%20description
<https://r-pkgs.org/description.html#:~:text=to%20be%20indented%3A-,Description,-%3A%20The%20descriptio>
I thought I had to add indentations...

So, I originally sent:
```
Description: Access and manipulate data from the Neotoma Paleoecology
Database. <https://api.neotomadb.org/api-docs/>
```

I was requested to add <https://..> referencing the "Neotoma Paleoecology
Database".

With the Description above, I do not get any local errors when running the
R CMD but can rejects it and gives me this error:


If I do this:
```
Description: Access and manipulate data from the Neotoma Paleoecology
Database.
<https://api.neotomadb.org/api-docs/>
```

and run the R CMD, I get the following message:
```
Unknown, possibly mis-spelled, fields in DESCRIPTION:
  ‘<https’
```
(however, it is not an error)


I see that I have to write complete sentences, so I have done the following:
```
Description: Access and manipulation of data using the Neotoma Paleoecology
Database.
<https://api.neotomadb.org/api-docs/>
```

I would llike to know if this is correct prior to submitting again. Or know
how should I place that <https...> tag

Thank you for all your help.

Socorro

On Mon, Apr 17, 2023 at 7:19 PM Sarah Goslee <sarah.goslee using gmail.com> wrote:

> Hi,
>
> The Writing R Packages manual is the main documentation, specifically:
> https://cran.r-project.org/doc/manuals/R-exts.html#The-DESCRIPTION-file
>
> As for indentation, don't. Just use a newline.
>
> I don't know of any templates, but the source code for many/most
> packages is on RForge and/or github, so you can look at as many
> DESCRIPTION files as you'd like to find the solutions you need.
>
> If that doesn't help, then please share actual examples of what isn't
> working in your file.
>
> Sarah
>
> On Mon, Apr 17, 2023 at 8:15 PM Socorro Dominguez
> <s.dominguez using ht-data.com> wrote:
> >
> > Hello!
> >
> > I need some help.
> >
> > Could you explain how to write the *Description* field in the
> *Description*
> > file when we need to add links? I don't find any rules on how to write it
> > when it includes links such as <https://...>
> >
> > Also, whenever I try to do a new line in the *Description* field with the
> > four spaces for indentation, I get an error from the R CMD
> >
> > If you could provide me with some sort of template example, I would be
> > extremely grateful.
> >
> > Best,
> >
> > Socorro
> >
> > --
> > Best regards,
> >
> > Socorro E. Dominguez-Vidaña
> > s.dominguez using ht-data.com
> >
> >         [[alternative HTML version deleted]]
> >
> > ______________________________________________
> > R-package-devel using r-project.org mailing list
> > https://stat.ethz.ch/mailman/listinfo/r-package-devel
>
>
>
> --
> Sarah Goslee (she/her)
> http://www.numberwright.com
>


-- 
Best regards,

Socorro E. Dominguez-Vidaña
s.dominguez using ht-data.com

	[[alternative HTML version deleted]]